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

Documentation is difficult to maintain #237

Open
alpaca-tc opened this issue May 30, 2024 · 0 comments
Open

Documentation is difficult to maintain #237

alpaca-tc opened this issue May 30, 2024 · 0 comments

Comments

@alpaca-tc
Copy link
Contributor

There are a number of HTML documents under git control under docs/.
Regenerating these shows that they have numerous diffs and are not well maintained.

cd docs
make build-docs
git diff HEAD | wc -l
    4653

In my opinion, there is no need to keep HTML documents under git control.
I think it would be better to keep only the .rst files under git control and build the generated HTML during the release process.

I am not familiar with the release process for this gem, so I am not sure if this opinion is nice.

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

1 participant