Skip to content

Agents: add front-end conventions - #336

Merged
ericholscher merged 3 commits into
mainfrom
claude/agent-rules
Oct 12, 2026
Merged

ericholscher merged 3 commits into
mainfrom
claude/agent-rules

Conversation

@ericholscher

@ericholscher ericholscher commented Oct 5, 2026 •

Copy link
Copy Markdown
Member

The CSS naming, theming and template conventions that come up in review on the theme repository aren't written down anywhere an agent reads them, so each one gets re-learned a review at a time. The Front-end section is where the shared file already points at ext-theme, so that is where they go.

ext-theme carries a copy of this file from earlier syncs but was missing from the sync list, and its pre-commit runs prettier on Markdown, which is how the copy drifted. Keeping this file in prettier's form means the sync lands there as a no-op under its hooks.

🤖 Generated with Claude Code

https://claude.ai/code/session_01XfbXavRE9UKS28VnSZikcL

Write down the CSS naming, theming and template conventions that come
up in review on the theme repository.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XfbXavRE9UKS28VnSZikcL
@ericholscher ericholscher changed the title Agents: point to per-repository rules and sync ext-theme Agents: add front-end conventions Oct 5, 2026
claude added 2 commits October 5, 2026 12:45
The theme repository carries a copy of the file but was not in the sync
list, so it had drifted.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XfbXavRE9UKS28VnSZikcL
The theme repository runs prettier on Markdown, so keep the shared file
in the form prettier produces and the sync stays a no-op there.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XfbXavRE9UKS28VnSZikcL
@ericholscher
ericholscher marked this pull request as ready for review October 5, 2026 12:53
@ericholscher
ericholscher requested a review from a team as a code owner October 5, 2026 12:53
@ericholscher
ericholscher requested a review from humitos October 5, 2026 12:53

@humitos humitos left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good.

Comment thread AGENTS.md

- Most templates/css/js are in a separate repository (https://github.com/readthedocs/ext-theme/).
- Fomantic UI is the design system. Use an existing variation before adding CSS, and never use inline styles or `!important`.
- Name custom CSS as a variation on the Fomantic element it extends, like `.ui.invertable.image` or `.ui.labeled.image`, and keep it in that element's `.overrides` file in the theme.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'm not sure about this, but I think it's correct. cc @agjohnson

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Going to merge, but happy to address any feedback if it comes in.

@ericholscher
ericholscher merged commit f8d0924 into main Oct 12, 2026
1 check passed
@ericholscher
ericholscher deleted the claude/agent-rules branch October 12, 2026 13:32
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.

3 participants