Chapter 2
Repositories
Everything lives in the knodemd organisation, and everything is public.
| Repository | What it is | Status |
|---|---|---|
.github | Organisation profile and shared community files | Active |
handbook | This handbook: how the project works | Active |
docs | How to install and use Knode, published at knode.md/docs | Active |
brand | The brand kit, generated from one source file | Active |
brand-license | The Knode Brand License and the trademark policy | Active |
web | knode.md: the website, with the developers, brand and licenses pages | Active |
knode | The product: Rust core, Mac, iPhone and web apps | Active |
format | The .knode specification and example files | Active |
homebrew-tap | brew install knodemd/tap/knode | Active |
cloud | Knode Cloud: sync, accounts, sharing, teams | Planned, v0.4 |
Docs or handbook? The docs explain how to use Knode, for anyone who installs it. The handbook
explains how the project works, for anyone who builds it. A change in knode that users see comes
with a matching pull request in docs.
New repositories are added here when they're created, and to map/repos.yml in .github, which draws the map on the organisation profile.
Naming
- Lowercase, words joined with hyphens (kebab-case):
brand,knode-cli. - Short and literal: name the thing, not the idea. No
knode-prefix unless the name would be ambiguous. - The display name, titles and descriptions use normal capitalisation ("Knode", "Brand kit").
Every repository has
- A
README.mdthat says what it is, how to run it and how to test it. - A
LICENSE(Apache 2.0) and aNOTICEcrediting Knode, from the first commit (see decision 0003). - Issues enabled, with the shared labels (see How we work).
- Community files inherited from
.github(contributing, code of conduct, security, templates).