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 docfx website for documentation #51

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

banchan86
Copy link

@banchan86 banchan86 commented Dec 31, 2024

This PR sets up the docfx infrastructure for documentation. Two points:

  • I modified the GitHub actions recipe dotnet.yml, but not sure if its the right modification
  • There is no GitHub Actions recipe added yet for online docs generation as it seems we are revamping the GitHub Actions workflow Use artifacts output layout and modern CI props zeromq#23 and I still need to learn how to do that.

@banchan86
Copy link
Author

@bruno-f-cruz @glopesdev

Copy link
Contributor

@bruno-f-cruz bruno-f-cruz left a 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.

@banchan86
Copy link
Author

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 the what the bonsai core uses. Unless there has been a decision to use a different standard that I am not aware about.

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 docs is separated from the src), but the Bonsai.Core docs repo actually imports Bonsai.Core as a submodule under the src folder. The most recent Bonsai packages (Bonsai.Mixer, Bonsai.ML, Bonsai.PulsePal, etc) use this layout as well. But I have no strong feelings about it and the last commit moves the src back to the top level, @glopesdev can review and make the final decision.

Copy link
Member

@glopesdev glopesdev left a 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.

docs/docfx.json Outdated Show resolved Hide resolved
docs/build.ps1 Outdated Show resolved Hide resolved
Co-authored-by: glopesdev <glopesdev@users.noreply.github.com>
@glopesdev glopesdev self-requested a review January 8, 2025 01:40
@glopesdev
Copy link
Member

@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.

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.

3 participants