pq-code-package / tsc

PQ Code Project Technical Steering Committee resources
https://pq-code-package.github.io/tsc/
Creative Commons Attribution 4.0 International
4 stars 4 forks source link

Create documentation for pq cp general info, projects summary and processes, #13

Closed planetf1 closed 3 months ago

planetf1 commented 7 months ago

As we build up the pqca project I think we should start documenting our processes

For example #11 discusses how repos may be named - others relate to codes of conduct, security.

Whilst we have the external website at https://pqca.org/ , I'm thinking of more operational/developer type information. Each project will also have detailed docs, and in some cases established documentation sites. I think we have another set of content in between where we document how the overall PQCA project is being run, what it offers, conventions & standards/ what our processes are etc.

A few approaches I can think of include

planetf1 commented 7 months ago

I'm thinking this would be useful to have in place for the first virtual hack day.

We could create a 'docs' repository (or any other name suggested!) and use it to capture cross-subproject docs. I suggested mkdocs as it allows some structure, but simple github pages is an alternative.

Specifically we could post a few starter links/pointers/notes for the hack day

It would start very basic - and we may later decide to change to something different, good to start somewhere

planetf1 commented 6 months ago

We have setup a new repository 'documentation' using mkdocs material.

This is published at https://docs.pqcodepackage.org

Currently empty but a candidate for the TSC to consider, and a mechanism to invite doc contributions during the hackathon.

planetf1 commented 4 months ago

Further updates have been made to the docs site in an effort to try and build an initial structure

planetf1 commented 3 months ago

Closing this as we have a docs website, and a CI process to publish. -- will open specific issues, prs for content that needs adding