Skip to content

Rename snippets according to docusaurus best practicesΒ #349

@smol-ninja

Description

@smol-ninja

I suggest renaming the snippets from CamelCase to _lower-case.

According to the docusaurus, using _ prefix avoids creating any doc page for snippets and marks it as "partial" to be imported by other files. Also, the plugin I am using to address #336 assumes snippets to follow _lower-case naming convention to work properly.

When this convention is used, LLM-ready markdown files will have snippets content directly embedded into the root markdown files.

@PaulRBerg since you added these snippets, was there any particular reason why you renamed them in CamelCase whereas all the other markdown files follow lower-case naming convention?

Metadata

Metadata

Assignees

Labels

effort: lowEasy or tiny task that takes less than a day.priority: 1This is important. It should be dealt with shortly.type: refactorChange that neither fixes a bug nor adds a feature.work: clearSense-categorize-respond. The relationship between cause and effect is clear.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions