question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[v2] ☂️ Umbrella issue for v2 docs

See original GitHub issue

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 (#1700 @wgao19)
  • Getting Started / Configurations → Themes, plugins, and presets configurations (#1929 thanks, @kadair!)
  • Getting Started / → themeConfig (relevant comment here)
  • 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 (@dt97)
  • Guides / Using Themes (#1645 @wgao19)
  • Guides / Reaching Users → search (#1734 @endiliey)
  • Guides / Reaching Users → analytics (#1678 @wgao19)
  • Guides / Reaching Users → SEO (@wgao19)
  • Guides / Deployment → Deployment with Netlify (#1719 @wgao19)
  • Advanced Guides / Plugins → @docusaurus/plugin-google-gtag (@wgao19)
  • Advanced Guides / Plugins → @docusaurus/plugin-ideal-image #1665 (@endiliey)
  • Advanced Guides / Themes (#1645 @wgao19)
  • Advanced Guides / Presets
  • API Reference / Lifecycle API (WiP #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

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Reactions:6
  • Comments:33 (25 by maintainers)

github_iconTop GitHub Comments

2reactions
yangshuncommented, Feb 24, 2020

I was browsing the pages of https://v2.docusaurus.io and I felt that the docs were very complete and hence I came to look at this issue and just realized that this issue is already 95% done! Amazing work @wgao19 and the others!

2reactions
garretteklofcommented, Nov 8, 2019

Yeah that would definitely allow me to import different styles, however that’s not really my concern. I could probably hack in some !important statements inside the custom css stylesheet — just trying to find the most elegant solution. Is there a full list of --ifm- variables anywhere? The Infima doesn’t look to have the docs ready. Thanks for the help regardless. There is some pretty cool stuff being done within this project!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Cisco Umbrella Documentation
Umbrella Help Center. Build Your Secure Internet Gateway. Docs Background. users. User Guides. How to use Umbrella ... Umbrella API Documentation. users ...
Read more >
Solved: Umbrella Reporting API issue - Cisco Community
Solved: I am trying to use https://developer.cisco.com/docs/cloud-security/#!reporting-v2-endpoints to experiment with various Umbrella API ...
Read more >
wikiwiki S Series Cantilever Patio Umbrellas 10 FT/8.2 * 8.2FT ...
Amazon.com : wikiwiki S Series Cantilever Patio Umbrellas 8.2 * 8.2FT Square Outdoor Offset Umbrella w/Fade ... We proudly offer a 2-Year canopy...
Read more >
Vampires Need Umbrellas - Mods - Minecraft - CurseForge
3,160,755 Downloads Last Updated: Sep 12, 2022 Game Version: 1.19.2 +3 ... This mod adds umbrellas that protect vampires from the sun.
Read more >
A Guide to Umbrella Facilities in Fund Finance | March 5 ...
Of course, the alternative to umbrellas is producing a strong precedent between a sponsor and lender which can be the basis for future ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found