Doc friendlyization

[asmacdo]

This PR cleans up the main page and organization for a friendlier intro to reproman

• Add overview
• move design docs out of sphinx
• docs build fixups

[gemini-code-assist]

Summary of Changes

Hello @asmacdo, 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 significantly enhances the project's documentation by restructuring existing content, introducing a new high-level overview, and implementing several build-related fixes. The changes aim to make the documentation more accessible, organized, and reliable for users and contributors.

Highlights

• Documentation Structure Refinement: Design-related documentation has been moved from the Sphinx docs/source/sandbox directory to a new design/ directory, improving the organization of conceptual documents.
• New Overview Document: A dedicated overview.rst file has been added to provide a high-level summary of ReproMan's purpose and capabilities, enhancing user onboarding.
• Documentation Build Improvements: Several fixes have been applied to the Sphinx configuration (conf.py) and documentation content, including setting the default language and updating intersphinx mappings, to ensure more robust and consistent documentation builds.
• Content Reformatting: The packages.rst file (now package-handling-reprozip.md) has been significantly re-formatted from reStructuredText to a more Markdown-like style, improving readability.
• Renamed Execution Doc: The execute.rst file has been renamed to execution.rst and its content updated for clarity, along with corresponding link updates in other documentation files.

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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 focuses on improving the documentation by adding an overview, moving design documents out of Sphinx, and applying several fixes to the documentation build process. The changes are well-structured and significantly enhance the documentation's clarity and organization. I've found a few minor stylistic issues, such as missing newlines at the end of files and a trailing whitespace, which I've commented on.