Skip to content

(docs) Reorganize content for "Docs Contributions" #21320

Closed
@tesseralis

Description

Summary

Reorganize and split up the content of "Docs Contributions" page and related pages for clarity.

Motivation

When I looked through the "Docs Contributions" page, I found it confusing and its content mixed in and repeated with other pages such as "Doc and Website Components".

Steps to resolve this issue

First, create a new "Writing docs in Markdown" page. This file should contain the sections of "Docs Contributions" and "Docs and Website components" that deal with actually writing docs in markdown. These include:

  • frontmatter options (e.g. table of contents, overview, stub issues)
  • available MDX components
  • other formatting options (headings, code blocks)

Second, split up the content of "Blog and Website Contributions" into "Blog Contributions" and "Website Contributions". "Blog Contributions" should contain most of the content of the old page. "Website Contributions" should contain:

  • The section "Making changes to the website" from "Blog and Website Contributions"
  • The section "Styling components on Gatbyjs.org with Theme-UI" from "Docs and Website Components"

Metadata

Assignees

No one assigned

    Labels

    help wantedIssue with a clear description that the community can help with.type: documentationAn issue or pull request for improving or updating Gatsby's documentationtype: question or discussionIssue discussing or asking a question about Gatsby

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions