Skip to content

Add content data documentation#395

Merged
zz-plant merged 1 commit into
mainfrom
codex/improve-repository-documentation-i8ote6
Jan 14, 2026
Merged

Add content data documentation#395
zz-plant merged 1 commit into
mainfrom
codex/improve-repository-documentation-i8ote6

Conversation

@zz-plant

Copy link
Copy Markdown
Owner

Motivation

  • Provide explicit guidance for JSON-backed structured content and validation so contributors can update src/content safely and discover the validation tooling.

Description

  • Add docs/content-data.md documenting content sources, common files, safe update steps, validation commands, and troubleshooting, and update docs/README.md and the top-level README.md to link the new guide (formatted with bunx prettier --write).

Testing

  • No automated tests were run because this is a docs-only change and bun run check was intentionally skipped.

Codex Task

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jan 14, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

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

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @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, docs/content-data.md, to standardize the process of managing and updating structured content within the src/content directory. The guide covers content sources, common file structures, safe content modification procedures, validation commands, and troubleshooting tips. This initiative aims to enhance contributor experience by providing clear instructions and ensuring data consistency and integrity across the project.

Highlights

  • New Content Data Documentation: A new markdown file, docs/content-data.md, has been added to provide explicit guidance for JSON-backed structured content, including validation and safe update steps for contributors.
  • Documentation Links Updated: The top-level README.md and docs/README.md files have been updated to include links to the newly created docs/content-data.md file, making the new guide easily discoverable.
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.

@zz-plant zz-plant merged commit 80f37c6 into main Jan 14, 2026
1 of 2 checks passed

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

Copy link
Copy Markdown
Contributor

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

Comment thread docs/content-data.md
Comment on lines +12 to +13
- `src/content/*.ts` exports shared TypeScript types and helper shapes that pages import when they
need consistent typing.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

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.

Suggested change
- `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.

Comment thread docs/content-data.md
Comment on lines +17 to +22
- `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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

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.

Suggested change
- `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. |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant