-
Notifications
You must be signed in to change notification settings - Fork 24
Rename snippets according to docusaurus best practices #349
Copy link
Copy link
Closed
Labels
effort: lowEasy or tiny task that takes less than a day.Easy or tiny task that takes less than a day.priority: 1This is important. It should be dealt with shortly.This is important. It should be dealt with shortly.type: refactorChange that neither fixes a bug nor adds a feature.Change that neither fixes a bug nor adds a feature.work: clearSense-categorize-respond. The relationship between cause and effect is clear.Sense-categorize-respond. The relationship between cause and effect is clear.
Metadata
Metadata
Assignees
Labels
effort: lowEasy or tiny task that takes less than a day.Easy or tiny task that takes less than a day.priority: 1This is important. It should be dealt with shortly.This is important. It should be dealt with shortly.type: refactorChange that neither fixes a bug nor adds a feature.Change that neither fixes a bug nor adds a feature.work: clearSense-categorize-respond. The relationship between cause and effect is clear.Sense-categorize-respond. The relationship between cause and effect is clear.
I suggest renaming the snippets from
CamelCaseto_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-casenaming 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
CamelCasewhereas all the other markdown files followlower-casenaming convention?