Skip to content
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

Merged
merged 1 commit into from
Sep 11, 2024
Merged

docs: create docs site #138

merged 1 commit into from
Sep 11, 2024

Conversation

jakim929
Copy link
Contributor

@jakim929 jakim929 commented Sep 11, 2024

  • 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

@jakim929
Copy link
Contributor Author

jakim929 commented Sep 11, 2024

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @jakim929 and the rest of your teammates on Graphite Graphite

@jakim929 jakim929 mentioned this pull request Sep 11, 2024
@jakim929 jakim929 force-pushed the 09-11-docs_create_docs_site branch 2 times, most recently from a669627 to 843c3bf Compare September 11, 2024 08:22
@jakim929 jakim929 marked this pull request as ready for review September 11, 2024 08:26
@jakim929 jakim929 requested a review from a team as a code owner September 11, 2024 08:26
Copy link
Contributor

@nitaliano nitaliano left a 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

@jakim929
Copy link
Contributor Author

 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

@nitaliano def agree! any thoughts on how to do this? I can add some scripts to run supersim fork --help and supersim --help then update the appropriate markdown files

@nitaliano
Copy link
Contributor

nitaliano commented Sep 11, 2024

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

@jakim929 jakim929 changed the base branch from 09-11-docs_shorten_readme.md to main September 11, 2024 17:47
@jakim929 jakim929 merged commit 9d26671 into main Sep 11, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants