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.

Porting documentation to Docusaurus

See original GitHub issue

Ref #5209, this issue will work as a base for planning the work of creating a Docusaurus documentation website for create-react-app.

Task list

An initial task overview might look like this:

This task list will be updated, edited and changed as we come up with more tasks, or split larger ones up into smaller ones.

Documentation structure

There are many ways of structuring the content found in this repo, but I think a good first approach is to split it into two parts:

  • Getting started (some of the information from the README.md file can go here)
  • User Guide (as is, for now)

From there, we can split it up into more narrow “groups”, if we find it appropriate and helpful for the user.

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Reactions:1
  • Comments:24 (21 by maintainers)

github_iconTop GitHub Comments

3reactions
selbekkcommented, Oct 24, 2018

We should probably make the docs searchable as well, but I think we can release this as is now.

@amyrlam has done some research here. We need to configure Docusaurus and then we need to set up Algolia’s DocSearch.

The latter, which will create an API key, is probably best done by one of the maintainers. Once it’s done, send me the API key, and I’ll create a pull request enabling the search feature.

2reactions
iansucommented, Oct 24, 2018

Versioning is probably something we’ll want eventually. I created an issue so we don’t forget about this: https://github.com/facebook/create-react-app/issues/5560

Read more comments on GitHub >

github_iconTop Results From Across the Web

Docs Introduction - Docusaurus
The docs feature provides users with a way to organize Markdown files in a hierarchical format.
Read more >
Docusaurus · Test Site - GitHub Pages
In your project repo, all of your documentation files should be placed inside a docs folder. Any blog posts should be inside a...
Read more >
Deploy a Docusaurus site · Cloudflare Pages docs
Select the new GitHub repository that you created and, in the Set up builds and deployments section, select Docusaurus as your Framework preset....
Read more >
Search for Documentation Sites - Typesense
Here's (opens new window) Docusaurus' documentation docsearch config. · Here's (opens new window) Typesense (Vuepress-based) Documentation Site's ...
Read more >
Richer API documentation with Redoc and Docusaurus
Docusaurus · Initialise a Docusaurus project · Make your OpenAPI spec available to your project · Add it as a custom field in...
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