Skip to content
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

chore(ci): create workflow to check the FrontMatter information in markdown #7

Open
lucaaamaral opened this issue Mar 20, 2025 · 2 comments · Fixed by #13
Open

chore(ci): create workflow to check the FrontMatter information in markdown #7

lucaaamaral opened this issue Mar 20, 2025 · 2 comments · Fixed by #13
Labels
enhancement New feature or request

Comments

@lucaaamaral
Copy link
Collaborator

lucaaamaral commented Mar 20, 2025

Problem

Docussaurus builds the sidebar according to the directory structure, detecting markdown files and listing the pages accordingly.
Docussaurus uses FrontMatter information to add the page's title and metadata.
We have a file sidebars.json with a list of files, check that is being used by the check_sidebars.py script.

Solution

Check if sidebars.json and if the check_sidebars.py is relevant, remove if not, document if it is.
Bring a CI check for presence and conformance of the FrontMatter header.

Non-goals

@lucaaamaral lucaaamaral changed the title feat: track files not referenced by docussaurus chore: track files not referenced by docussaurus Mar 20, 2025
@lucaaamaral lucaaamaral added the enhancement New feature or request label Mar 25, 2025
@lucaaamaral lucaaamaral reopened this Mar 25, 2025
@lucaaamaral
Copy link
Collaborator Author

lucaaamaral commented Mar 25, 2025

Although the workflow introduced by #13 checks for reference to new files, we still do not have a way of checking on pre-existing ones.

Suggestion: modify this script, adding the possibility to run locally against all markdown files.

@see7e
Copy link
Contributor

see7e commented Mar 25, 2025

Although the workflow introduced by #13 checks for reference to new files, we still do not have a way of checking on pre-existing ones.

Suggestion: modify this script, adding the possibility to run locally against all markdown files.

This is adressed at #14

PR closed due to replacement of the script with Docusaurus own sasnity checks and additional Markdown linters.

@lucaaamaral lucaaamaral changed the title chore: track files not referenced by docussaurus chore(ci): create workflow to check the FrontMatter information in markdown Mar 26, 2025
@lucaaamaral lucaaamaral changed the title chore(ci): create workflow to check the FrontMatter information in markdown chore: track files not referenced by docussaurus Mar 26, 2025
@lucaaamaral lucaaamaral changed the title chore: track files not referenced by docussaurus chore(ci): create workflow to check the FrontMatter information in markdown Apr 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
2 participants