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

Migrate to DocC Combined Documentation #221

Open
orchetect opened this issue Oct 19, 2024 · 0 comments
Open

Migrate to DocC Combined Documentation #221

orchetect opened this issue Oct 19, 2024 · 0 comments
Labels
📚 documentation Improvements or additions to documentation

Comments

@orchetect
Copy link
Owner

orchetect commented Oct 19, 2024

DocC currently has an experimental combined documentation feature that can combine docs for multiple package targets and synthesize a landing page to navigate them using navigation hierarchy.

I spent some time refactoring TimecodeKit's documentation to adopt this feature and it works fairly well.

Until now, MIDIKit has used a rather complex set of manual scripts I built in order to merge docs from all of its targets together and perform the required structural and syntax changes required to accommodate it. This new DocC feature makes most, if not all, of that a 1st-party feature and would make the scripts redundant.

@orchetect orchetect added the 📚 documentation Improvements or additions to documentation label Oct 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant