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.

Wrong path to sidebars.json in generated readme

See original GitHub issue

🐛 Bug Report

docusaurus-init will currently generate a website/README.md that references website/sidebar.json, which does not exist. It seems like it should be website/sidebars.json.

Have you read the Contributing Guidelines on issues?

Yes

To Reproduce

  1. docusaurus-init

Expected behavior

website/README.md refers to website/sidebars.json

Actual Behavior

website/README.md refers to website/sidebar.json

Reproducible Demo

Clone https://github.com/testing-library/testing-library-docs and open website directory

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
yangshuncommented, Dec 9, 2019

Just edit in one shot on master 😃

0reactions
nickmccurdycommented, Dec 9, 2019

Seems like it was just 1.x

Read more comments on GitHub >

github_iconTop Results From Across the Web

Bad DX for sites without sidebar file · Issue #4752
We should warn if sidebarsPath is using a path to a sidebar file that does not exist. The text was updated successfully, but...
Read more >
Autogenerated
Docusaurus can create a sidebar automatically from your filesystem structure: each folder creates a sidebar category, and each file creates ...
Read more >
Doc-as-code: docfx.exe User Manual - NET
Defines the output folder of the generated metadata files. Relative paths are relative to the docfx.json file being used. To go up a...
Read more >
Configuration
Function that returns examples file path for a given component path. For example, instead of Readme.md you can use ComponentName.examples.md :.
Read more >
docusaurus-plugin-openapi-docs
OpenAPI plugin for generating API reference docs in Docusaurus v2. ... generated OpenAPI docs MDX files, versions.json and sidebar.js (if ...
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