Welmed Standards Repository

Repository for documenting approved standards (coding, architectural, project management) for the Welmed project.

To propose/discuss a new standard, or to propose/discuss changes to an existing one, one should branch from master and open a new pull request.

Documents must be written using Markdown.

Developer notes

One can browse the HTML version of the documentation locally

• using make up and navigating to http://localhost:8000 (live reload).
• issuing make build and opening ./dist/index.html in the browser.

Resources

• mkdocs (the site generator used)
• mkdocs-material (the theme for mkdocs and Docker image used)
• mkdocs-awesome-pages-plugin (plugin for improved navigation bar management)