Skip to content

Conversation

@soheimam
Copy link
Collaborator

@soheimam soheimam commented Jan 8, 2026

Added claude md file inital

@cb-heimdall
Copy link
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

Copy link
Collaborator

Choose a reason for hiding this comment

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

Like the direction here, but we should consider what of this could be implemented with a deterministic linter that is run by a script.

We should be able to put instructions to run the linting script in this command or we could create a Skill to do this. This will help preserve context and improve linting outcomes (in the traditional sense of linting)

Then anything that can't be done by a traditional linter could be done by the LLM

- MDX files in `docs/` folder
- Storybook for component demos

## Git
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this necessary? If I'm building a new page on a branch, does claude need to know the primary branch? I dont think so.

- Every MDX file should have frontmatter with at least `title` and `description`
- Frontmatter must be valid YAML between `---` fences

### Heading structure
Copy link
Contributor

Choose a reason for hiding this comment

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

It may also be good as a basic lint to include a check if no headers exist at all as header tags help SEO/LLM-SEO optimize so we should have at least one on every page, even if it is <h1 (ie, h3).

Copy link
Contributor

Choose a reason for hiding this comment

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

This could also be a warning that we can choose not to enforce

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.

5 participants