docs reorg #491
Merged
docs reorg #491
Conversation
This file contains 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
-NO MERGE - This pr includes a reorg for the docs site to give an idea of what I am thinking. I still need to finish some descriptions on the landing pages and work to find unique images but this should give a rough idea of the layout and flow. - Note - I have a somewhat similar pr in the works for the chialisp site also, some docs are moving to that repo. Changes included in this pr: Renamed a series of pages (slugs/urls were maintained where possible, redirects in place otherwise): - Guides -> Dev Guides - Farming Guide -> Farming Guide - Offers - GUI -> Wallet Guide - Using the GUI -> Using the Chia GUI - Installation -> Advanced Installation Updated header links - all external links are now on the right side with the language selection - updated docs link to a home page - updated dev guides link to a homepage Creating a series of new categories on the docs main site and the Guides subpage: Docs categories created: - Advanced User Docs - Troubleshooting - Learn More Dev Guides categories created: - Primitives Chialisp Site categories created: Moved a series of pages to new locations (all old locations have had redirect pages added as needed) - Using the Chia GUI -> Getting Started - Beginners Wallet Guide -> Getting Started - Advanced Installation -> Advanced User Docs - Testnets -> Advanced User Docs - Plotting -> Advanced User Docs - Farming -> Advanced User Docs - Reference Client -> Advanced User Docs - RPC Reference -> Advanced User Docs - CLI Reference -> Advanced User Docs - Wallet Connect -> Advanced User Docs - Check If Things Are Working -> Troubleshooting - Node Syncing -> Troubleshooting - Logging Reference -> Troubleshooting - Coin Set Model -> Learn More - Architecture -> Learn More - Consensus -> Learn More - Keys -> Learn More - Protocol -> Learn More - Green Paper -> Learn More - Resources -> Learn More - NFT Guide -> Primitives - CAT Guide -> Primitives - DataLayer -> Primitives - Clawback -> Primitives - Offers -> Primitives - DAOs -> Primitives - VCs -> Primitives - Custody Tool -> Tutorials - WalletConnect -> Tutorials - Simulator User Guide -> Tutorials - Seeder User Guide -> Tutorials Created Pages: - Chia Docs Home - Primitives landing page (setup as generated index in sidebar) - Dev Guides Home TODO: Page moves: - Chialisp Concepts (and contained files) -> Chialisp site - Chialisp Primer (and contained files) -> Chialisp site - Coin Set Model (costs, conditions) -> Chialisp site Finish Pages: - update descriptions on all landing pages to make them more engaging - update images on home pages to make each unique Create a contributors guide illustrating how to contribute content while maintaining formatting
danieljperry
previously approved these changes
Jan 29, 2024
There was a problem hiding this comment.
I have browsed through the whole site and it looks good. I like the organization. As you mentioned, some of the thumbnail images are reused multiple times, but that can always be updated later. Thanks for working on this, I think the site is less daunting now for beginners, and more advanced users will still be able to find what they are looking for.
- updates the landing page descriptions for the docs and guides pages (academy is not included in this commit)
- updates links for all pages that have been moved to the chialisp site and hides from the sidebar, this allows for users who directly access the pages to see the correct redirect links
- updates the dev guides home description
- based on feedback from rigidity, this readds the conditions page to the docs site. NOTE - this means the conditions doc will be duplicated on the docs and chialisp sites, if any changes occur on either the other needs to be updated to reflect
adds unique images for each landing page item, also removes the card headers from these to eliminate redundancy
this cleans up all of the chinese translation pages to align with the docs reorg
fixes the video series images for better display of title
reduces image sizes by ~30%
|
Note - when merging we will want to squash this pr 👍 |
danieljperry
previously approved these changes
Feb 14, 2024
mando222
approved these changes
Feb 20, 2024
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
-This PR is now at a place where it can be merged once approved, no additional work is needed.
Changes included in this pr:
Renamed a series of pages (slugs/urls were maintained where possible, redirects in place otherwise):
Updated header links
Creating a series of new categories on the docs main site and the Guides subpage:
Docs categories created:
Dev Guides categories created:
Chialisp Site categories created:
Moved a series of pages to new locations (all old locations have had redirect pages added as needed)
Created Pages:
TODO:
Create a contributors guide illustrating how to contribute content while maintaining formatting