Skip to content

README: Update directions for updating documentation #1147

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.

Sign up for GitHub

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

Merged
vojtechtrefny merged 1 commit into from
Nov 25, 2025
Merged

README: Update directions for updating documentation #1147

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.DEVEL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,10 +140,10 @@ Making releases
- [ ] Generate documentation for the Python bindings as described below and copy
it to *docs/html*

- [ ] Update the documentation by rsyncing the contents of the *docs/html*
folder elsewhere, switching to the *gh-pages* branch, rsyncing the
contents back and committing it as an update of the docs for the new
release.
- [ ] Update the documentation by copying the contents of the *docs/html*
folder to the *libblockdev* directory in the
[Storaged project website repository](https://github.com/storaged-project/storaged-project.github.io)
and commit and push the changes
Comment on lines +143 to +146
Copy link

@gemini-code-assist gemini-code-assist bot Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The instruction to 'commit and push the changes' is a bit vague. For better clarity and consistency with other release steps (e.g., line 128 which specifies a commit message format), I suggest making this instruction more specific and reformatting for readability.

Suggested change
- [ ] Update the documentation by copying the contents of the *docs/html*
folder to the *libblockdev* directory in the
[Storaged project website repository](https://github.com/storaged-project/storaged-project.github.io)
and commit and push the changes
- [ ] Update the documentation by copying the contents of the *docs/html*
folder to the *libblockdev* directory in the
[Storaged project website repository](https://github.com/storaged-project/storaged-project.github.io),
then commit with a message like 'docs(libblockdev): Update for vX.Y.Z' and push.


Generating Python bindings documentation
-----------------------------------------
Expand Down