chore: restructure docs front/landing page, fix link fmt, typos

[haakonvt]

The front page of our documentation is a million miles long. This PR shortens it considerably by specifying different maxdepth settings for different subsections.

[gemini-code-assist]

Summary of Changes

Hello, 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 improving the readability and navigability of the project's documentation. The primary change involves a significant reorganization of the main documentation landing page, breaking down a previously long list of topics into more manageable, categorized sections. This restructuring, combined with the strategic use of maxdepth settings, aims to present a more concise and user-friendly overview of the documentation content. Additionally, minor textual corrections were made in the migration guide.

Highlights

• Documentation Restructuring: The main documentation landing page (index.rst) has been significantly restructured into logical sections like "Getting Started", "Core Resources", "Data Processing", "Specialized Features", and "Reference" to improve navigation.
• maxdepth Settings Applied: maxdepth directives were applied to toctree entries on the documentation landing page to control the displayed depth of subsections, making the page shorter and easier to navigate.
• Link Format Correction: A link in MIGRATION_GUIDE.md was updated from reStructuredText inline link format to Markdown-style link format for consistency.
• Typo Fix: A minor typo related to Datapoints and DatapointsArray requirements was corrected in MIGRATION_GUIDE.md.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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.

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 improves the documentation by restructuring the main index page for better readability and navigation. It groups the table of contents into logical sections like 'Getting Started' and 'Core Resources', and applies different maxdepth settings to shorten the landing page. Additionally, it includes minor fixes, such as correcting a link format in the migration guide and fixing a typo.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.40%. Comparing base (36037e2) to head (393a5c1).
⚠️ Report is 5 commits behind head on pysdk-release-v8.

Additional details and impacted files

@@                 Coverage Diff                  @@
##           pysdk-release-v8    #2516      +/-   ##
====================================================
- Coverage             93.48%   93.40%   -0.09%     
====================================================
  Files                   478      478              
  Lines                 48118    48163      +45     
====================================================
+ Hits                  44983    44986       +3     
- Misses                 3135     3177      +42     

see 6 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[haakonvt]

🦄

[haakonvt]

🦄