Skip to content

ecosystem(mskanban): add MSKanban documentation#10

Merged
Musiker15 merged 1 commit into
mainfrom
docs/mskanban
May 25, 2026
Merged

ecosystem(mskanban): add MSKanban documentation#10
Musiker15 merged 1 commit into
mainfrom
docs/mskanban

Conversation

@Musiker15
Copy link
Copy Markdown
Member

Summary

Adds MSKanban as the third entry under ecosystem/, mirroring the msk-paste / msk-shortener layout.

  • Project: MSK-Scripts/mskanban
  • Current release: v0.1.0-beta
  • Replaces the placeholder "MSKanban planned" note in ecosystem/intro.md

Pages

Seven pages under ecosystem/mskanban/:

File Content
_category_.json Sidebar entry (position 4 — after MSK Shortener)
index.md Overview, USP table vs Trello/Jira/Planka/Wekan, tech stack
installation.md Self-host guide: Docker + bare-metal Apache, full env-var reference
getting-started.md First-10-minutes walkthrough with the zero-knowledge model explained for non-crypto users
features.md Tour: boards, 5 views (Kanban/Calendar/Timeline/Table/Analytics), milestones, automation, real-time, presence
api.md REST API reference (~56 routes summarised in tables, OpenAPI spec linked)
privacy.md Full key hierarchy, what the server sees vs doesn't, threat model summary, GDPR
faq.md Common questions — recovery key loss, 502 troubleshooting, Passkey RP-ID mismatch, etc.

Build check

$ yarn build
[SUCCESS] Generated static files in "build".
Done in 10.36s.

No broken links (the project's onBrokenLinks: 'throw' is on). 117/120 documents indexed by lunr-search; build emits seven new HTML pages under /ecosystem/mskanban/.

Notes

  • All deep-links to MSKanban-specific files (ADRs, threat model, source code) point at the upstream repo so they keep working as MSKanban evolves
  • The "planned: MSKanban" line in ecosystem/intro.md is replaced with a live link to the new section
  • Style mirrors the existing ecosystem docs — :::info, :::tip, :::warning, table-heavy reference style, single index.md overview followed by feature pages

Adds MSKanban as the third entry under ecosystem/, mirroring the
msk-paste / msk-shortener layout. Seven pages: overview, installation
(Docker + bare-metal Apache), getting started (with the zero-knowledge
model explained for users), features tour, REST API reference, privacy
& security with the full key hierarchy, and FAQ.

Also updates ecosystem/intro.md to list MSKanban among the existing
projects instead of as "planned".

`yarn build` succeeds with no broken links (onBrokenLinks: 'throw'
is on). 117/120 docs indexed by lunr.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: Musiker15 <info@musiker15.de>
@github-actions
Copy link
Copy Markdown

⚠️ Deprecation Warning: The deny-licenses option is deprecated for possible removal in the next major release. For more information, see issue 997.

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@Musiker15 Musiker15 merged commit 3ad703f into main May 25, 2026
4 checks passed
@Musiker15 Musiker15 deleted the docs/mskanban branch May 25, 2026 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant