-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
Closed
Labels
documentationThe issue is related to the documentation of DocusaurusThe issue is related to the documentation of Docusaurusgood first issueIf you are just getting started with Docusaurus, this issue should be a good place to begin.If you are just getting started with Docusaurus, this issue should be a good place to begin.help wantedAsking for outside help and/or contributions to this particular issue or PR.Asking for outside help and/or contributions to this particular issue or PR.
Description
Why contribute to Docusaurus v2 docs?
- Docusaurus 2 is built with brilliance and so you may want to know how:
- your dev hot reload server builds and rebuilds in matters of seconds and milliseconds
- the client site will be an SPA, code-split by route, and pages are load lightning fast without even a spinner, how is that even possible 🌚
- site works even without javascript
- Your very chance of experiencing docs composed from scratch, rephrase, from code, to human language on a popular OS project
- Enjoy the pleasure of finding things out, teach and share it with others, practice writing skills
- Slash her majesty will be your friend!
List of doc pieces up for grabbing
Docs
- Introduction / Contributing (docs(v2): contributing for v2 #1700 @wgao19)
- Getting Started / Configurations → Themes, plugins, and presets configurations (docs(v2): theme, plugin, and preset config #1929 thanks, @kadair!)
- Getting Started / →
themeConfig
(relevant comment here) - Getting Started / Initialization – feat(v2): @docusaurus/init package #1655
- Guides / Styling and Layouts → Styling components with CSS-in-JS frameworks
- Guides / Docs / Sidebar → Subcategories (docs(v2): subcategories #1670 @wgao19)
- Guides / Docs / Static Assets (@endiliey)
- Guides / Blogs (@dt97)
- Guides / Using Themes (docs(v2) themes #1645 @wgao19)
- Guides / Reaching Users → search (docs(v2): search - algolia and custom #1734 @endiliey)
- Guides / Reaching Users → analytics (docs(v2): analytics #1678 @wgao19)
- Guides / Reaching Users → SEO (@wgao19)
- Guides / Deployment → Deployment with Netlify (docs(v2): deploy to netlify #1719 @wgao19)
- Advanced Guides / Plugins →
@docusaurus/plugin-google-gtag
(@wgao19) - Advanced Guides / Plugins →
@docusaurus/plugin-ideal-image
feat(v2): @docusaurus/plugin-ideal-image #1665 (@endiliey) - Advanced Guides / Themes (docs(v2) themes #1645 @wgao19)
- Advanced Guides / Presets
- API Reference / Lifecycle API (WiP docs(v2): document plugins and lifecycle APIs #1724 @wgao19)
API Reference / Themes API
API Reference / Presets API - docusaurus/link, useBaseUrl, head (wip @endiliey)
Miscellaneous
- Update all headings to sentence case (@yangshun)
Working on a doc piece
Within the markdown files for each of the doc pieces above, you may find in comment blocks some suggested outlines and reference materials:
- Where to look in our code regarding the topic
- Our v1 doc on the corresponding feature
- Doc pieces from external projects on similar topics
As you work on the docs, use existing and external materials critically as examples or inspirations. You are more than welcome to explain things in your own style.
Also, feel free to ask us if you have any questions. You may tag us directly in your PR.
Adopting a doc piece
- Create a PR and reference this issue
- Within your PR, mark clearly which piece(s) you are working on
- Once we see your PR, we'll mark in this issue that the corresponding piece is under work in progress by you
- If you don't feel like continue working on the piece, close the PR so that other people can pick it up
Note that:
- Your initial work does not have to include all the content for the piece, put WIP to indicate that you are working on it
- You don't need to ask for permission or progression, etc. As long as there is no open PR (we will mark it beside the section), you can pull one up for the piece you are working on
Have you read the Contributing Guidelines on issues?
Yes
yangshun, guyca, fanny, rmkanda, restrictedCodex and 1 more
Metadata
Metadata
Assignees
Labels
documentationThe issue is related to the documentation of DocusaurusThe issue is related to the documentation of Docusaurusgood first issueIf you are just getting started with Docusaurus, this issue should be a good place to begin.If you are just getting started with Docusaurus, this issue should be a good place to begin.help wantedAsking for outside help and/or contributions to this particular issue or PR.Asking for outside help and/or contributions to this particular issue or PR.