This document establishes an opinionated guiding framework for file organization and project management, designed to accommodate users of all technical backgrounds. It provides a simple, copy-and-paste system for creating new project workspaces, archiving completed work, and syncing cloud storage, ensuring a clean, accessible, and efficient environment.
The guide is available online at https://workspace-101.pages.dev or in PDF format on the releases page
This project uses the just command runner alongside external utility program like typst, typos, git, and git-cliff.
- Make your changes.
just cleanjust check(fix any typos), thenjust format- Commit using Conventional Commits and Keep a Changelog specifications.
just bump-calver(Only ifworkspace.md,workspace.typ, orinstall/*changed)just buildjust deploy(Only ifworkspace.mdorwebsite.typchanged)just publish(Only if releasing a new version)
If you notice something wrong or broken, let us know by opening an issue, or better yet, a pull request with how you think it should be fixed.
Released under the MIT license. See LICENSE.