Skip to content

docs: reorder top-level doc sections, separate DM from legacy (DM-3572)#2481

Merged
haakonvt merged 3 commits intomasterfrom
top-level-docs-cleanup
Feb 22, 2026
Merged

docs: reorder top-level doc sections, separate DM from legacy (DM-3572)#2481
haakonvt merged 3 commits intomasterfrom
top-level-docs-cleanup

Conversation

@haakonvt
Copy link
Copy Markdown
Contributor

@haakonvt haakonvt commented Feb 19, 2026

Also clarifies assets, events, relationships and annotations by adding "legacy" to separate them from Data Modeling.

https://cognitedata.slack.com/archives/CN9QYQRSR/p1759140364589119

Screenshot 2026-02-19 at 09 50 32
Screenshot 2026-02-19 at 09 50 47

@haakonvt haakonvt requested review from a team as code owners February 19, 2026 08:44
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @haakonvt, I'm Gemini Code Assist1! 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 clarity and structure of the project's documentation. It involves a strategic reordering of the main table of contents to present information more intuitively and updates specific section titles to explicitly mark older functionalities as 'legacy', thereby reducing potential confusion with current data modeling approaches.

Highlights

  • Documentation Reordering: The top-level documentation sections in the index.rst file have been reordered to improve logical flow and organization.
  • Legacy Section Clarification: The 'Assets' and 'Events' documentation sections have been updated to include '(legacy)' in their titles, distinguishing them from newer data modeling concepts.

🧠 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.

Changelog
  • docs/source/assets.rst
    • Updated the main heading from 'Assets' to 'Assets (legacy)'.
  • docs/source/events.rst
    • Updated the main heading from 'Events' to 'Events (legacy)'.
  • docs/source/index.rst
    • Reordered several documentation sections within the table of contents, including moving 'documents' up, and 'geospatial', 'hosted_extractors', 'postgres_gateway', 'data_organization', 'utils', and 'base_data_classes' to new positions.
Activity
  • No human activity 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.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation by renaming the 'Assets' and 'Events' sections to 'Assets (legacy)' and 'Events (legacy)' to better distinguish them from newer Data Modeling features. It also reorganizes the top-level sections in the main index file for a more logical structure. The changes are accurate and improve the clarity and organization of the documentation. No issues were found.

@haakonvt
Copy link
Copy Markdown
Contributor Author

This change follows the recent change we did for the deprecated Vision API:

Screenshot 2026-02-18 at 13 34 44

@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 48.86%. Comparing base (059e457) to head (5e1f965).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2481   +/-   ##
=======================================
  Coverage   48.85%   48.86%           
=======================================
  Files         191      191           
  Lines       26157    26157           
=======================================
+ Hits        12780    12781    +1     
+ Misses      13377    13376    -1     

see 2 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.

@erlendvollset
Copy link
Copy Markdown
Contributor

In the API reference docs they're marked as "classic". Should we do the same here?

@haakonvt
Copy link
Copy Markdown
Contributor Author

In the API reference docs they're marked as "classic". Should we do the same here?

Good question, we should probably follow the official docs.

Copy link
Copy Markdown
Contributor

@erlendvollset erlendvollset left a comment

Choose a reason for hiding this comment

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

Didn't seem like the tech writers had very strong opinions on this, so let's go ahead.

@erlendvollset
Copy link
Copy Markdown
Contributor

🦄

@haakonvt haakonvt added this pull request to the merge queue Feb 22, 2026
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Feb 22, 2026
@haakonvt haakonvt added this pull request to the merge queue Feb 22, 2026
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Feb 22, 2026
@haakonvt haakonvt changed the title docs: reorder top-level documentation sections docs: reorder top-level doc sections, separate DM from legacy (DM-3572) Feb 22, 2026
@haakonvt haakonvt added this pull request to the merge queue Feb 22, 2026
Merged via the queue into master with commit 3db85d7 Feb 22, 2026
21 checks passed
@haakonvt haakonvt deleted the top-level-docs-cleanup branch February 22, 2026 07:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants