README: Update directions for updating documentation

[vojtechtrefny]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @vojtechtrefny, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the development README to reflect a new, streamlined process for deploying project documentation. This change simplifies the release procedure by replacing a multi-step rsync and branch-switching method with a direct copy to the dedicated project website repository, ensuring documentation is updated more efficiently.

Highlights

• Documentation Update Process: The instructions for updating documentation during a release have been revised. Previously, it involved rsyncing to and from a gh-pages branch. Now, it directs users to copy the docs/html content directly into the libblockdev directory of the storaged-project/storaged-project.github.io repository and then commit and push those changes.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request updates the developer documentation to reflect a new process for publishing documentation. The change moves from using a gh-pages branch to updating a separate repository for the project website. My feedback includes a suggestion to make the new instructions more specific, particularly regarding the commit message format, to ensure consistency and improve readability.

[gemini-code-assist]

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.