Add content data documentation#395
Conversation
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
et3 | 35c60f1 | Commit Preview URL Branch Preview URL |
Jan 14 2026, 05:05 AM |
Summary of ChangesHello @zz-plant, 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 introduces a new documentation guide, Highlights
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
Code Review
This pull request introduces new documentation for managing JSON-backed content, which is a great addition for contributors. The new docs/content-data.md file is well-structured and provides clear guidance on content sources, safe updates, and validation. I've made a couple of suggestions to further improve the clarity and readability of the new documentation file. Overall, this is a valuable contribution to the project's documentation.
| - `src/content/*.ts` exports shared TypeScript types and helper shapes that pages import when they | ||
| need consistent typing. |
There was a problem hiding this comment.
For better clarity and to help new contributors find files faster, it's a good practice to use the specific file path src/content/types.ts instead of a glob pattern, especially since it's the only file matching that pattern currently.
| - `src/content/*.ts` exports shared TypeScript types and helper shapes that pages import when they | |
| need consistent typing. | |
| - `src/content/types.ts` exports shared TypeScript types and helper shapes that pages import when they | |
| need consistent typing. |
| - `src/content/home.json` contains the homepage hero, feature cards, and CTA copy. | ||
| - `src/content/start-here.json` captures the onboarding flow content for the start-here route. | ||
| - `src/content/glossary.json` and `src/content/library.json` contain the glossary terms and library | ||
| patterns used across the site. | ||
| - `src/content/field-notes.json` and `src/content/participation.json` store long-form page copy for | ||
| those routes. |
There was a problem hiding this comment.
To improve readability, consider converting this list into a table. This format is used elsewhere in the project's documentation (like the 'Common scripts' section in the main README.md) and would make the information easier to scan.
| - `src/content/home.json` contains the homepage hero, feature cards, and CTA copy. | |
| - `src/content/start-here.json` captures the onboarding flow content for the start-here route. | |
| - `src/content/glossary.json` and `src/content/library.json` contain the glossary terms and library | |
| patterns used across the site. | |
| - `src/content/field-notes.json` and `src/content/participation.json` store long-form page copy for | |
| those routes. | |
| | File(s) | Purpose | | |
| | --- | --- | | |
| | `src/content/home.json` | Contains the homepage hero, feature cards, and CTA copy. | | |
| | `src/content/start-here.json` | Captures the onboarding flow content for the start-here route. | | |
| | `src/content/glossary.json`, `src/content/library.json` | Contain the glossary terms and library patterns used across the site. | | |
| | `src/content/field-notes.json`, `src/content/participation.json` | Store long-form page copy for those routes. | |
Motivation
src/contentsafely and discover the validation tooling.Description
docs/content-data.mddocumenting content sources, common files, safe update steps, validation commands, and troubleshooting, and updatedocs/README.mdand the top-levelREADME.mdto link the new guide (formatted withbunx prettier --write).Testing
bun run checkwas intentionally skipped.Codex Task