Update README: fix links, build note, license attribution

[anthonymarkQA]

Update readme file only in main

---

Note

Low Risk
README-only documentation edits (links/text/build notes) with no runtime or security impact.

Overview
Updates README.md to point readers to the published docs site and adds a note that the newest docs may not be merged into this repo’s main branch yet.

Adds a Building the documentation section (Python 3.11 requirement, pyenv note, and make html/make livehtml steps) and refreshes contribution links/URLs. Updates the license blurb to clarify CC BY 4.0 attribution and community/ACN maintenance.

^{Written by Cursor Bugbot for commit fddb674. This will update automatically on new commits. Configure here.}

[gemini-code-assist]

Summary of Changes

Hello @anthonymarkQA, 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 focuses on enhancing the README.md file to provide more accurate, clear, and comprehensive information for users and contributors. The changes aim to improve the discoverability of documentation, streamline the setup process for building the documentation locally, and update legal and contribution details, thereby improving the overall onboarding experience and information accuracy.

Highlights

• Documentation Links: The main documentation link has been updated for clarity and a note added regarding the potential for the latest documentation to not yet be merged to the main repository.
• Build Instructions: A new section 'Building the documentation' has been added, detailing the requirement for Python 3.11 and instructions for using pyenv and make commands.
• Contribution Guidelines: The 'Contribute' section links have been revised to point to a more descriptive 'How to contribute to the project' page and updated the labels for issue tracker and source code.
• License Attribution: The 'License' section has been updated to clarify that the documentation is licensed under CC BY 4.0 and to attribute maintenance to the OpenSPP community and ACN.

Changelog

• README.md
  • Updated the primary documentation link to be more prominent and added a note about the latest documentation status.
  • Introduced a new section 'Building the documentation' with specific instructions for Python 3.11, pyenv, and make commands.
  • Revised the 'Contribute' section by updating the link for contribution guidelines and rephrasing the labels for the issue tracker and source code.
  • Modified the 'License' section to explicitly state the license for the documentation and acknowledge the maintainers.

Activity

• No human activity (comments, reviews, etc.) has been recorded on this pull request yet.

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 README.md file to fix links, add build instructions, and update license attribution. The changes improve clarity and provide essential information for contributors. However, I've noted an inconsistency in the required Python version mentioned across different documentation files, which could cause confusion. I've left a comment to address this.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud