Organize docs in more suitable layout #856
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The current docs structure focuses on someone setting up a server and then running medic, whereas with us running a publically available mediator instance, its fair to say more users will just download medic and then want to get started, without installing a their own server Signed-off-by: Luke Hinds <luke@stacklok.com>
Signed-off-by: Luke Hinds <luke@stacklok.com>
Signed-off-by: Luke Hinds <luke@stacklok.com>
Signed-off-by: Luke Hinds <luke@stacklok.com>
There was a problem hiding this comment.
I think we're using yarn, so you don't want to check in package-lock.json at all.
| @@ -27,14 +27,14 @@ | |||
| // @ts-check | |||
| const fs = require('fs'); | |||
There was a problem hiding this comment.
Do we want to just use autogenerated sidebars, which would look like:
module.exports = {
autogenerated_sidebar: [
{
type: 'autogenerated',
dirName: './docs'
]
};There was a problem hiding this comment.
I am not sure its possible to silo into individual categories then
evankanderson
approved these changes
Sep 5, 2023
This was referenced Nov 2, 2023
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current docs structure focuses on someone setting up a server and then running medic, whereas with us running a publicly available mediator instance, its fair to say more users will just download medic and then want to get started, without installing a their own server