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

Publish library documentation #248

Open
ghost opened this issue Feb 21, 2021 · 0 comments
Open

Publish library documentation #248

ghost opened this issue Feb 21, 2021 · 0 comments

Comments

@ghost
Copy link

ghost commented Feb 21, 2021

To allow for the creation of more frontends, having easily accessible code documentation would be quite useful.
As distinst is written in Rust, a GitHub Workflow can be created to automatically generate & publish this documentation to GitHub Pages, so long as the code itself is properly documented.
I myself have written a workflow for one of my own projects which accomplishes exactly this (the end result being quite nice to look at).

I understand this may not be important to those already contributing to this project. I raise this issue because I'm interested in writing a GTK frontend for this library in Rust, and working with this project as a dependency would be quite difficult without documentation, considering the massive, intricate, and ever-changing codebase; the overwhelming majority of developers that could be interested in using this library are also not willing to spend a significant amount of their time pouring through this repository, myself included.
I acknowledge the API is not stable, and, thus, publishing a new release to the Rust package registry or publishing documentation would be something you might outright reject without much thought (I am well aware of issue #206). However, given that publishing documentation can be automated, it would require very little effort to provide something this useful for developers wishing to make their own frontends. So long as the code files remain properly documented, the web documentation should continue to remain quite useful.

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

No branches or pull requests

0 participants