Skip to content

Chapter 2

Repositories

Everything lives in the knodemd organisation, and everything is public.

RepositoryWhat it isStatus
.githubOrganisation profile and shared community filesActive
handbookThis handbook: how the project worksActive
docsHow to install and use Knode, published at knode.md/docsActive
brandThe brand kit, generated from one source fileActive
brand-licenseThe Knode Brand License and the trademark policyActive
webknode.md: the website, with the developers, brand and licenses pagesActive
knodeThe product: Rust core, Mac, iPhone and web appsActive
formatThe .knode specification and example filesActive
homebrew-tapbrew install knodemd/tap/knodeActive
cloudKnode Cloud: sync, accounts, sharing, teamsPlanned, 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.md that says what it is, how to run it and how to test it.
  • A LICENSE (Apache 2.0) and a NOTICE crediting 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).

Edit on GitHub