Menu

Community

Verification Required

Help improve Stornamics docs.

Use the Community section to report precise docs gaps, propose evidence-backed changes, and keep public contribution work routed to the right product, content type, owner, and reviewer.

Community Routes

  • Available: DOCS-077

    Contributor guide

    Public-safe guide for reporting docs gaps, proposing content changes, preparing local validation, and understanding review expectations.

  • Available: DOCS-078

    Docs style guide

    Voice, page structure, example, claim, status-label, limitation, and product wording rules for public-ready docs changes.

  • Available: DOCS-080

    Public docs roadmap

    Community-friendly view of docs launch-foundation progress, current work, upcoming launch readiness, and ways to help.

  • Available: DOCS-079

    Community issue templates

    Public-safe intake templates for missing docs, incorrect docs, examples, compatibility reports, and product questions.

  • Available: DOCS-081

    LLM-friendly docs surfaces

    Public-route based llms.txt, full text, and JSON manifests for retrieval, summarization, and docs gap analysis without private source paths.

  • Available: DOCS-082

    Good-first-docs starter issues

    Copy-ready, public-route based starter issue backlog for low-risk docs contributions across products.

  • Available: DOCS-083

    Community governance model

    Maintainer roles, response expectations, merge requirements, and credit notes for external docs work.

Contribution Paths

Report a docs gap

Best first step

Use this when a page is missing, hard to follow, outdated, or unclear about product maturity.

  • Page route or product area
  • Expected reader goal
  • What is missing or confusing
  • Any claim, example, limit, or support impact

Propose a content change

Source contributors

Use this for wording, structure, navigation, glossary, concept, guide, or reference improvements.

  • Product and content type
  • Evidence or reviewer needed
  • Validation commands run locally
  • Screenshots when the rendered page changes

Improve an example

Evidence required

Use this when command examples, SDK snippets, tutorial steps, or expected output need clearer coverage.

  • Example status and route
  • Smoke test or reviewer-run rationale
  • Expected output and cleanup
  • Known limits that should stay visible

Escalate a product claim

Reviewer routed

Use this when a docs change touches availability, support, durability, performance, security, privacy, legal, or scale language.

  • Exact claim being changed
  • Product owner or SME
  • Evidence source and last-checked date
  • Required sensitive reviewer role

Review Guardrails

Keep claims evidence-backed

Do not strengthen product behavior beyond the owning status, compatibility, limits, or evidence page.

Separate docs work from product commitments

A docs roadmap item means documentation work is planned or active; it does not change product availability.

Protect customer and private details

Remove credentials, customer identifiers, payload bodies, private topology, and unpublished implementation details from examples and reports.

Make review easy to route

Name the product, content type, maturity label, affected route, and reviewer role when a change needs specialized review.