docs: Complete overhaul of Astro Starlight documentation#23
Merged
Conversation
I've completed a full overhaul of the documentation for Applio, which is built with Astro Starlight. My goal was to improve the grammar, text structure, and overall accessibility to make the documentation easier for you to use, regardless of your skill level. Here are the specific changes I made: - A consistent style guide was applied to all documentation files to ensure a uniform tone and formatting. - The introduction (`index.mdx`) was rewritten to be more welcoming and engaging. - The installation guide (`installation.mdx`) was restructured to be more user-friendly, with a clear recommended installation path and a separate section for advanced methods. - The dataset creation guide (`how-create-datasets.mdx`) was enhanced with more detailed instructions and context. - All other documentation files were reviewed and refined for clarity, grammar, and structure. This includes guides for the Audio Analyzer, Embedders, Inference, Google Colab, Plugins, Voice Blender, KaraFan, and UVR. - The Terms of Service (`tos.mdx`) was reformatted for better readability. - Descriptive alt text was added to all images. - The use of Starlight components, such as `Card`, `CardGrid`, `Steps`, `Tabs`, and `Aside`, was standardized to improve the visual presentation of the documentation. - The folder `apps/applio-docs/src/content/docs/getting-started/other-alternatives.mdx` was renamed to `apps/applio-docs/src/content/docs/getting-started/google-colab-guide.mdx` to better reflect its content.
Deploying applio-website with
|
| Latest commit: |
bfc21c2
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f49f0403.applio-website-stable.pages.dev |
| Branch Preview URL: | https://docs-overhaul.applio-website-stable.pages.dev |
Deploying applio-docs with
|
| Latest commit: |
bfc21c2
|
| Status: | 🚫 Build failed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I've completed a full overhaul of the documentation for Applio, which is built with Astro Starlight. My goal was to improve the grammar, text structure, and overall accessibility to make the documentation easier for you to use, regardless of your skill level.
Here are the specific changes I made:
index.mdx) was rewritten to be more welcoming and engaging.installation.mdx) was restructured to be more user-friendly, with a clear recommended installation path and a separate section for advanced methods.how-create-datasets.mdx) was enhanced with more detailed instructions and context.tos.mdx) was reformatted for better readability.Card,CardGrid,Steps,Tabs, andAside, was standardized to improve the visual presentation of the documentation.apps/applio-docs/src/content/docs/getting-started/other-alternatives.mdxwas renamed toapps/applio-docs/src/content/docs/getting-started/google-colab-guide.mdxto better reflect its content.