Labs, Projects and Artifacts

Work in Paramsat is arranged in three levels: a Lab holds projects, and a project holds artifacts.

The Lab

A Lab belongs to one person and holds their projects. Its page lists the projects and the most recent artifacts across all of them. A Lab's address is its owner's name, and its projects are under it: Tejas's Lab is at paramsat.com/tejas, and the pages of this project are under paramsat.com/tejas/paramsat.

Projects

A project is a body of work with one subject: a programming language, a tool, a study. Its pages are arranged like a documentation site, and its Landing is the page a visitor reaches first.

A project is divided into sections, which the sidebar shows in order:

• Docs: reference and guides, kept current.
• Posts: articles and design notes, newest first.
• Notes: shorter working notes.
• Releases: what changed, release by release.
• Data: datasets and the descriptions that go with them.

A project uses only the sections it needs. Inside a section, pages can be gathered into groups, such as the chapters of a guide, which open and close in the sidebar.

Artifacts

An artifact is a single piece of published work: a document, an article, a note, a release, a dataset, or a response to another artifact. Each is written in Markdown, with a short header of facts about it: its title, its kind, its topics, when it was published and revised, and the links that tie it to other work.

An artifact keeps its address once it is published, so a link to it goes on working. An unfinished artifact can be marked as a draft, and a draft appears nowhere, not in the sidebar, not in any list and not in search, until it is published.

Topics

A topic gathers projects and artifacts on one subject, whichever projects they belong to. Each topic has its own page under Topics.