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

Refactor auto-generate aeon_acquisition docs #49

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

Conversation

lochhh
Copy link
Collaborator

@lochhh lochhh commented Oct 17, 2024

aeon_acquisition docs are currently generated as .md files using a combination of dotnet and docfx.

This PR:

Changes can be previewed here.

@lochhh lochhh requested a review from glopesdev October 18, 2024 16:02
@lochhh lochhh marked this pull request as ready for review October 18, 2024 16:02
@glopesdev
Copy link
Collaborator

glopesdev commented Oct 19, 2024

@lochhh one issue with replacing docfx entirely is we will lose the ability to reference these docs from bonsai itself since we need a xrefmap.yml file.

Also long term we don't necessarily want to document a bonsai library using pure C# docs since bonsai users don't know much about the C# language and it might be misleading for them. We are making standard doc templates for bonsai in docfx and maintaining two stacks of templates will be really hard for us.

Long term I don't really know how best to resolve this yet but I am concerned it will make the docs a bit too different from other packages that people might be lost in how to read them.

Let's discuss next week and I can show some of the existing bonsai package doc pages.

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.

Broken URL in auto-generated Acquisition API reference
2 participants