search

nesi / support-docs

NeSI Mkdocs based support pages.
https://docs.nesi.org.nz/
6 stars 5 forks source link

Style Guide #355

Open CallumWalley opened 1 month ago

CallumWalley commented 1 month ago

We don't need a full style guide (for now), some standardisation around use of specific technical words would be useful.

Also should apply in our workshops, and general support work.

Some examples

Distributed Memory Parallelism (instead of MPI, OpenMPI) Shared Memory Parallelism (instead of oMP, Multithreading, Multiprocessing) Simultaneous Multithreading, SMT (instead of Hyperthreading)

Probably lots of other examples.

CallumWalley commented 1 month ago

Internal links should use the page title as link text. (unless they link to an anchor link in which case it should be that header)