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

[v2] ☂️ Umbrella issue for v2 docs #1640

Open
wgao19 opened this issue Jul 6, 2019 · 2 comments

Comments

Projects
None yet
3 participants
@wgao19
Copy link
Collaborator

commented Jul 6, 2019

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 open for grab

Docs

  • Introduction / Contributing
  • Getting Started / Configurations → Themes, plugins, and presets configurations
  • Getting Started / Initialization – #1655
  • Guides / Styling and Layouts → Styling components with CSS-in-JS frameworks
  • Guides / Docs / Sidebar → Subcategories (#1670 @wgao19)
  • Guides / Docs / Static Assets (@endiliey)
  • Guides / Blogs
  • Guides / Using Themes (wip by @wgao19)
  • Guides / Reaching Users → search
  • Guides / Reaching Users → analytics (wip #1678 by @wgao19)
  • Guides / Reaching Users → SEO (@wgao19)
  • Guides / Deployment → Deployment with Netlify
  • Advanced Guides / Plugins → @docusaurus/plugin-content-gtag
  • Advanced Guides / Plugins → @docusaurus/plugin-ideal-image #1665
  • Advanced Guides / Themes (wip by @wgao19)
  • Advanced Guides / Presets
  • API Reference / Themes API (wip by @wgao19)
  • API Reference / Presets API

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

@kushthedude

This comment has been minimized.

Copy link

commented Jul 15, 2019

@wgao19 I would like to help with some of the parts

@wgao19

This comment has been minimized.

Copy link
Collaborator Author

commented Jul 15, 2019

@kushthedude sounds great! You may PR directly for the piece you hope to work on. Thank you!

@endiliey endiliey added the 2.x label Jul 18, 2019

This was referenced Jul 19, 2019

@endiliey endiliey changed the title ☂️ Umbrella issue for v2 docs [v2] ☂️ Umbrella issue for v2 docs Jul 24, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.