-
Notifications
You must be signed in to change notification settings - Fork 379
added initial claude #783
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
added initial claude #783
Conversation
🟡 Heimdall Review Status
|
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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).
There was a problem hiding this comment.
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
Added claude md file inital