Skip to content

Conversation

@cdmurph32
Copy link
Collaborator

No description provided.

@crandmck
Copy link
Collaborator

crandmck commented Nov 3, 2025

I can't tell from the workflow, but will this remove existing files in the /docs/classes, /docs/interfaces, etc. directories? I added an index.md file in each one. It's not ideal to have these handwritten (copied from the README.md actually) but until I come up with a way to automate this, those files help construct the doc UI.

I also made a very small edit to /docs/README.md but that's not critical.

@cdmurph32
Copy link
Collaborator Author

Yes. I'll clean that up.

@crandmck
Copy link
Collaborator

crandmck commented Nov 5, 2025

PR #30 has updates to the build:docs command so that building docs won't overwrite the Jekyll scaffolding files. Probably we should land that first to address my prior comment.

I wonder if instead of updating the release workflow if we should add a separate workflow to publish the docs on release, as we did in the Python and C repos?

@crandmck
Copy link
Collaborator

Closing in favor of #32 which automates doc generation and publication.

@crandmck crandmck closed this Nov 13, 2025
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