-
Notifications
You must be signed in to change notification settings - Fork 47
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: create docs site #138
Conversation
jakim929
commented
Sep 11, 2024
•
edited
Loading
edited
- create a docs site using mdbook (similar to the spec repo)
- create scaffolding + initial docs
- examples / guides have not been filled out yet
- set up CI to deploy using github pages
This stack of pull requests is managed by Graphite. Learn more about stacking. |
3cfe788
to
fbd157e
Compare
4b36e90
to
3dd5d17
Compare
fbd157e
to
3add726
Compare
a669627
to
843c3bf
Compare
843c3bf
to
cc893d4
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good start! i think it could be a good idea to have a portion of our docs like cli commands and things of that nature generated based on the comments in our go code so it always can stay in sync without anyone needing to hand write anything
@nitaliano def agree! any thoughts on how to do this? I can add some scripts to run |
3add726
to
9b53979
Compare
cc893d4
to
5afd191
Compare
9b53979
to
06a48ef
Compare
5afd191
to
901afe8
Compare
something like mdox might be useful for this https://github.com/bwplotka/mdox it can even be as simple as running supersim and just extracting all the text from the help command |
901afe8
to
6f89e76
Compare
6f89e76
to
d3ad20b
Compare