Add docs sidebar #11817
Add docs sidebar #11817
Conversation
It's sketchy JSON let's commit before we break i
summary.md is no longer functional it's higherarchy was translated into sidebar.js as a JSON format that docusaurus likes
github-actions
bot
added
the
area/documentation
|
Sidebar.js is a large part of this commit and doesn't show by default |
| @@ -1,15 +1,70 @@ | |||
| # docs (by Docusaurus) | |||
| # Introduction | |||
There was a problem hiding this comment.
This is a copy of /README.md Docusaurus doesn't like doing above it's root directory. I tried a symlink and the link appears to fail docusaurus's build steps so I just copied to move past the problem as a blocker
There was a problem hiding this comment.
Does this mean we have a duplicate? If we can't figure this out, we could change the workflow to copy the top level readme in this directory as part of the workflow.
@Amruta-Ranade do you have thoughts on the repo readme vs the docs.airbyte.io readme? We've kept it the same for continuity. I want to continue doing so and was wondering if you have other plans.
There was a problem hiding this comment.
I do have plans to edit the landing page text. The repo readme is perfect for the OSS audience but I'd like the docs readme to be more user-centric. Keeping them separate makes sense to me.
|
|
|
pushing to update docs |
| const sidebars = { | ||
| // By default, Docusaurus generates a sidebar from the docs folder structure | ||
| tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], | ||
| module.exports = { |
There was a problem hiding this comment.
the was the one done by hand?
|
Nicely done. Is this now live on doc.airbyte.io? |
What
Adds sidebar with the same layout as the old sidebar
How
Wrote JSON to match the format provided from the old docs