-
Notifications
You must be signed in to change notification settings - Fork 2
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
Quality check everything #27
Comments
@Antonfogelberg By adding
to the YAML front matter of all pages, author and date information will be added to the page. Only drawback is that the dates are generated when (if) a user creates a new page using the CLI, meaning it's not updated automatically and thereby isn't a completely trustworthy source of when a page was last modified, unless a style guide is written reminding authors to update the date field. I still think an indication of when-ish information was written would be useful, as some texts (such as Project Moore/basics mentions PUL) doesn't make sense in a contemporary sense. |
I agree on this |
Our documentation site should give every new utn developer enough information and guidance for them to do their work.
The guides and information needs to be understandable for everyone and not only experienced developers.
We need to go over every thing and make sure that docs is working for it's intended use.
Remove information that is irrelevant.
Replace poor descriptions with clearer and easier ones.
If a topic is hard to explain in text, think if a image or some other kind of media would better describe the problem.
When a problem is found with a page, create a new issue and link it with the parent issue for that page.
In each of the following issues there is a short todo list as a reminder of what to look for. This does not need to be followed religiously.
#17
#18
#19
#20
#21
#22
#23
#24
#25
#26 (Not so sure if this needs any QA but lets check it anyway)
#28
The text was updated successfully, but these errors were encountered: