-
Notifications
You must be signed in to change notification settings - Fork 3
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 docfx website for documentation #51
base: main
Are you sure you want to change the base?
Conversation
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.
Let's remove the TOC references to the non existing articles for a cleaner PR history.
Also, can we leave the packages at the top level without moving them to a src folder? This is the current standard that I am using and also what the bonsai core uses. Unless there has been a decision to use a different standard that I am not aware of.
I have removed the TOC references to the non-existing articles. The Bonsai.Core probably isn't the best repo to emulate as it is structured quite differently from the other package repos (the |
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.
Looks good, only very minor comments, and one thing I was starting to investigate is whether to add the favicon and logo directly to the template in docfx-tools
or not.
It won't be used for all projects, but it could be set as the default in case no icon is specified, similar to how the DocFX logo itself is part of the default template and used if no other asset is defined.
Co-authored-by: glopesdev <glopesdev@users.noreply.github.com>
@banchan86 looks good, maybe let's wait for the review and merge of bonsai-rx/zeromq#23 and we can review whether we want to bring over some of the patterns used there. |
This PR sets up the docfx infrastructure for documentation. Two points: