Skip to content

Latest commit

 

History

72 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

specdoc

specdoc mascot

spec collaboration and lifecycling that isn't terrible.

specs usually rot in a docs platform nobody reviews or a PR nobody can edit together. specdoc uses hedgedoc under the hood. specs are collaborative markdown notes with inline criticmarkup comments, reviewed on a kanban board, and finally created as PRs in their target repo once approved.

spec board with draft, review, and approved lanes

editor with criticmarkup suggestions and margin comments

workflow

a note becomes a spec via frontmatter tags: [spec, <status>] with statuses draft, ready-for-review, in-review, approved, implemented. reviewers and quorum come from .specs/roles.yml in the branch-protected target repo. a comment thread starts the review; approval needs quorum plus every thread resolved, then the board locks the note and opens specs/NNN-slug.md as a PR. a commit containing implements #N closes the loop.

full walkthrough: spec lifecycle. adding a repo: onboarding a project.

license

AGPL-3.0 (see LICENSE); the editor is a hedgedoc derivative and keeps its license. editor/critic.bundle holds the fork's commits over the upstream base tag. bundled source sans pro fonts are SIL OFL 1.1 (spec-board/fonts/LICENSE).

About

spec collaboration and lifecycling that isn't terrible

Topics

Resources

Contributing

Stars

3 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages