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.

Sign up for GitHub

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

Jump to bottom

suggestion: add doc template with DIVIO organization #408

Open
lmiq opened this issue Jun 8, 2023 · 2 comments
Open

suggestion: add doc template with DIVIO organization #408

lmiq opened this issue Jun 8, 2023 · 2 comments
Labels
new-feature A proposed feature (which is not a new plugin)

Comments

@lmiq
Copy link

lmiq commented Jun 8, 2023

Many people has praised the way this site suggests organizing software documentation: https://documentation.divio.com/

Maybe it would be nice if the template generated by PkgTemplates created a structured docs following those guidelines, with some simple examples on what each section could contain.

That would be helpful in guiding the process of building structured documentation for new developers.
@oxinabox
Copy link
Collaborator

oxinabox commented Jun 8, 2023

I like this idea.
I would happily review a PR to change our documentor plug-in to support it as a flag.

@nickrobinson251 nickrobinson251 added the new-feature A proposed feature (which is not a new plugin) label Jun 8, 2023
@lmiq
Copy link
Author

lmiq commented Jun 8, 2023

Cool. I'll try to draft something asap

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
new-feature A proposed feature (which is not a new plugin)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@oxinabox @nickrobinson251 @lmiq