Skip to content
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 1 commit into from
Mar 12, 2019

Conversation

fk
Copy link
Contributor

@fk fk commented Mar 12, 2019

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:

image

  • 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):

image

image

/cc @calcsam @marcysutton

- 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).
@fk fk requested a review from a team March 12, 2019 21:51
@fk fk requested a review from a team as a code owner March 12, 2019 21:51
Copy link
Contributor

@calcsam calcsam left a 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!

@fk fk merged commit d3d6b53 into master Mar 12, 2019
@fk fk deleted the topics/docs-link-main-sections-in-introduction branch March 12, 2019 22:05
@fk
Copy link
Contributor Author

fk commented Mar 12, 2019

Should have renamed [[guidelist]] to [[sectionToc]] or something. 🤦‍♂️
Let's do that when we move to MDX (#12514).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants