Przejdź do treści
Biblioteka skilli
Dokumenty i biuro · Konwersja i formaty

docs-canvas

/docs-canvas

Renderuje dokumentacyjny canvas OpenBitFun, który porządkuje notatki architektoniczne, referencje API, przewodniki, runbooki i how-to w nawigowalny układ ze spisem treści, diagramami i odnośnikami.

Repozytorium
openbitfun ↗
Licencja
MIT
Ostatnia zmiana repozytorium
27.10.2026

Ocena i bezpieczeństwo

100/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
1
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 27.10.2026, bez odwołań do wycofanych modeli i API.

Licencja

MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.

Co robi i kiedy

Renderuje dokumentacyjny canvas OpenBitFun, który porządkuje notatki architektoniczne, referencje API, przewodniki, runbooki i how-to w nawigowalny układ ze spisem treści, diagramami i odnośnikami.

Oryginalny opis (EN)

Render a documentation-style OpenBitFun Canvas that organizes architecture notes, API references, walkthroughs, runbooks, and how-tos into a navigable layout with sections, tables of contents, diagrams, and cross-references. Use when the user asks for a docs canvas, documentation overview, architecture walkthrough, API reference page, codebase map, runbook, or wants to render structured documentation as an interactive canvas.

Jak działa

  1. Prerequisites
  2. Gather the source material
  3. Plan the canvas layout
  4. Render with canvas primitives
  5. Tone and content
  6. Be creative
Sekcje z nagłówków SKILL.md, w oryginale · 45 linii, 388 słów
Podgląd SKILL.md
---
name: docs-canvas
description: >-
  Render a documentation-style OpenBitFun Canvas that organizes architecture
  notes, API references, walkthroughs, runbooks, and how-tos into a navigable
  layout with sections, tables of contents, diagrams, and cross-references.
  Use when the user asks for a docs canvas, documentation overview,
  architecture walkthrough, API reference page, codebase map, runbook,
  or wants to render structured documentation as an interactive canvas.
---

# Docs Canvas

Build a canvas that presents documentation — architecture notes, API references, design docs, runbooks, or codebase walkthroughs — as an interactive, navigable surface rather than as a flat markdown file.

> **Status:** placeholder. The skill structure is in place so the canvas
> welcome page can surface this plugin via the marketplace query, but the
> full skill body still needs to be written. Treat the steps below as a
> starting outline and refine as the docs canvas pattern matures.

## Prerequisites

Read `openbitfun-canvas` first. It contains the generation policy, design guidance, slop rules, self-check, Canvas runtime rules, and SDK usage notes.

## Gather the source material

Accept any of: a directory of markdown files, a single doc URL, an inline outline, or a question to answer from the codebase. Collect headings, code blocks, diagrams, and any cross-references between documents.

## Plan the canvas layout

Decide the top-level structure before writing any components. A docs canvas usually has:

1. **Overview** — A short summary card with the purpose of the doc, scope, and audience.
2. **Table of contents** — Navigable list of sections, ideally pinned or sticky so the reader can jump around.
3. **Body sections** — One section per logical unit (architecture, API, examples, gotchas). Each section can mix prose, code blocks, diagrams, and callouts.
4. **References** — Links to related docs, source files, RFCs, and external material.

## Render with canvas primitives

Prefer built-in canvas components over raw HTML:

- Use cards/sections to group related content visually.
- Use code blocks with syntax highlighting for snippets.
- Use diagrams (DAG layout, mermaid) for architecture.
- Use callouts for "Important", "Warning", "Note", "Deprecated".
- Use tables for API parameter lists and option matrices.

## Tone and content

Write reader-facing prose. Lead with the answer or the headline, then explain. Keep examples small and runnable. Cite source files with `code references` so readers can jump in.

## Be creative

The sections above are a floor, not a ceiling. The goal is the fastest possible path for the reader to understand the topic — so look at the source material in front of you and ask what representation would actually help. A diagram, a sequence chart, a side-by-side comparison, a decision tree, a glossary, a curated FAQ, a single large worked example — whatever fits.

Wersje

RepozytoriumWynikLicencja
Ta strona · gcwing/openbitfun100MIT
v1truv1us/ai-eng-system100MIT
v1truv1us/ai-eng-system100MIT
OutlineDriven/outline-driven-development90Apache-2.0

Migawka bazy z 13.11.2026 · wersja paczki 1f6293b9ec14 (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 100pr-review-canvas
    Tworzy w OpenBitFun Canvas wizualny przegląd PR lub diffu z kartami zmian, mapą recenzji i ostrzeżeniami o ryzyku.
  • 100openbitfun-canvas
    Tworzy interaktywny canvas w React otwierany obok czatu dla analiz ilościowych, audytów, wykresów, tabel i narzędzi wielokrotnego użytku w OpenBitFun.
  • 100markdown-docs
    Pisze lub restrukturyzuje dokumentację projektu w Markdown (README, przewodniki, referencje, runbooki, notatki architektury) wokół tego, co czytelnik chce zrobić, także gdy dokumentacja jest nieaktualna lub brakuje jej.
  • 100agent-technical-writer
    Specjalizuje się w dokumentacji technicznej: Architecture Decision Records, dokumentacja API, przewodniki migracji, runbooki i bazy wiedzy.
  • 100technical-writing
    Tworzy i audytuje dokumentację techniczną: README, referencje API, runbooki, ADR i notatki o wydaniach, aby były dokładne i utrzymywalne.
  • 100technical-documentation
    Pisze dokumentację techniczną, która pomaga czytelnikowi obsługiwać, wdrażać i utrzymywać system: README, przewodniki, runbooki i notatki migracyjne.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.