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: track files not referenced by docussaurus #7

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

chore: track files not referenced by docussaurus #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

The files to be displayed in the Docussaurus needs to be included in the sidebars.json file. If the file is not included there, it might not be displayed. Docussaurus documentation.

Solution

Track them down & fix that.
A CI check for files not referenced would be a plus. Content in this PR might solve this issue: magma/magma#15152

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
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