-
Notifications
You must be signed in to change notification settings - Fork 10.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(docs): Link to main sections from /docs/
#12529
Merged
Merged
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
- add landing pages for - Guides - API Reference - Releases & Migration - Conceptual Guide - Advanced Tutorials to `docs/docs/`; their intro paragraph is taken from the copy at `www/src/pages/docs/index` / https://www.gatsbyjs.org/docs/ - link those in `www/src/data/doc-links.yaml` and `www/src/pages/docs/index` - `/docs/guides/` - `/docs/api-reference/` - `/docs/releases-and-migration/` - `/docs/conceptual-guide/` - `/docs/advanced-tutorials/` - link „Ecosystem“ and „Advanced Tutorials“ in `www/src/pages/docs/index` Slightly tweak `www/src/templates/template-docs-markdown`: Change „Guides in this section“ headline preceding the list of child articles to say „In this section“, thus making it work for non „Guides“ articles (e.g. the newly added landing pages).
calcsam
approved these changes
Mar 12, 2019
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, nice work @fk!
Should have renamed |
This was referenced May 25, 2021
Open
This was referenced Sep 16, 2021
Open
This was referenced Dec 1, 2021
This was referenced Jun 24, 2023
This was referenced Nov 28, 2023
This was referenced Jan 5, 2024
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.
TL;DR: Link the pages on https://www.gatsbyjs.org/docs/ marked in the screenshot below, add the required landing pages, and also link the corresponding items in the "Docs" sidebar navigation:
to
docs/docs/
; their intro paragraph is taken from the copy atwww/src/pages/docs/index
/ https://www.gatsbyjs.org/docs/www/src/data/doc-links.yaml
andwww/src/pages/docs/index
/docs/guides/
/docs/api-reference/
/docs/releases-and-migration/
/docs/conceptual-guide/
/docs/advanced-tutorials/
www/src/pages/docs/index
Slightly tweak
www/src/templates/template-docs-markdown
: Change „Guides in this section“ headline preceding the list of child articles to say „In this section“, thus making it work for non „Guides“ articles (e.g. the newly added landing pages):/cc @calcsam @marcysutton