You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently, you have to run mllint list all and mllint describe some-slug to get information about a rule. It would be better if mllint's CI would auto-generate some content for a website on this repo at every release.
Idea: - Implement generating Markdown version of Wiki page containing docs on every rule and category in mllint. - Use this Wiki page creator action to generate a Wiki page from the mllint generated Markdown code.
Tasks:
Look into and set up Github Pages
Create a basic website (using Hugo)
Find a good theme (PaperMod)
Write some content for any other pages.
Implement a script to generate Hugo content from rules & categories descriptions
Set up CI pipeline to automatically deploy the website on pushes to master or on tagged releases.
Update ReadMe with link to website.
Merge to master
The text was updated successfully, but these errors were encountered:
Currently, you have to run
mllint list all
andmllint describe some-slug
to get information about a rule. It would be better ifmllint
's CI would auto-generate some content for a website on this repo at every release.Idea:- Implement generating Markdown version of Wiki page containing docs on every rule and category inmllint
.- Use this Wiki page creator action to generate a Wiki page from themllint
generated Markdown code.Tasks:
The text was updated successfully, but these errors were encountered: