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

Add general documentation #50

Draft
wants to merge 26 commits into
base: main
Choose a base branch
from

Conversation

bruno-f-cruz
Copy link
Contributor

@bruno-f-cruz bruno-f-cruz commented Dec 27, 2024

Closes #49
This PR adds general documentation to the Bonsai.Sgen tool.

It would greatly benefit from the latest docfx-tools, so for now I will simply write the articles and leave this as a draft.

@bruno-f-cruz bruno-f-cruz changed the title Add general document Add general documentation Dec 27, 2024
@bruno-f-cruz
Copy link
Contributor Author

bruno-f-cruz commented Dec 28, 2024

@glopesdev @banchan86 Any chance we can get the new docs deployment rolling on this repository?

@banchan86
Copy link

@glopesdev @banchan86 Any chance we can get a new docs rolling on this repository?
I can handle this next on my to-do list!

@banchan86
Copy link

banchan86 commented Dec 31, 2024

Hey @bruno-f-cruz I setup the docfx website, I built on top of your changes because you had already setup some stuff, but I don't have permission to push changes to your fork. Do you want to add me to it? For now I just set it up on https://github.com/banchan86/sgen-docs/tree/docs-add-general-docs. Couple of issues:

  1. There is an empty bonsai file, person-and-pet-enum.bonsai, thus no image is being generated for that file.
  2. I moved the source code into its own src folder in keeping with how we have recently organized our repos, but that might break the GitHub Actions workflow dotnet.yml. Not sure how to change it though.
  3. Local docfx preview works if you just want to see the website while revising the docs, but I have not added a GitHub Actions recipe for online docs generation, as it seems we are revising it Use artifacts output layout and modern CI props zeromq#23. It makes quite a few changes, and I am not confident in reproducing it yet (I am also not sure its set in stone).
  4. Also found this little bug while generating the local preview, not sure why I didn't catch it before haha Workflow container padding lost for workflows >3 levels high docfx-tools#19.

@bruno-f-cruz
Copy link
Contributor Author

Thanks for setting it up. I should have clarified a bit more what I meant, sorry! Do not worry about the content of my PR for now. All we need is to add the docs structure to the main branch via a separate PR and I will rebase on my end!
Once again thanks :)

@banchan86
Copy link

Thanks for setting it up. I should have clarified a bit more what I meant, sorry! Do not worry about the content of my PR for now. All we need is to add the docs structure to the main branch via a separate PR and I will rebase on my end! Once again thanks :)

ah i see ok im raising a separate PR!

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.

Add general documentation
2 participants