Skip to content

Latest commit

 

History

History
114 lines (90 loc) · 3.79 KB

documentation.md

File metadata and controls

114 lines (90 loc) · 3.79 KB
name Documentation Issue
about Report documentation issues, suggest improvements, or request new documentation
title [Docs] Brief description of the issue or improvement
labels documentation
assignees

Component

  • formulus (React Native mobile app)
  • formulus-formplayer (React web app)
  • synkronus (Go backend server)
  • synkronus-cli (Command-line utility)
  • Design System / Design Tokens
  • API Documentation
  • Setup / Installation Guides
  • Deployment Documentation
  • General / Root Documentation
  • Other (please specify)

Documentation Type

  • Missing documentation (documentation doesn't exist)
  • Outdated documentation (information is incorrect or stale)
  • Unclear documentation (hard to understand)
  • Incomplete documentation (missing important details)
  • Broken links or references
  • Formatting or typo issues
  • Translation needed
  • New documentation needed
  • Other (please describe)

Which part of the documentation needs improvement?

File/Path: Section: URL (if applicable):

Describe the issue or suggestion

Current State

Problem or Gap

Proposed Change (if any)

Suggested Content

Suggested Structure

Why is this change important?

Impact Level:

  • Critical (blocks users or causes errors)
  • High (causes confusion or incorrect usage)
  • Medium (improves clarity or completeness)
  • Low (nice to have, minor improvement)

Additional Context

Screenshots or Examples

Related Documentation

User Impact

  • New users / First-time setup
  • Developers / Contributors
  • End users / Consumers
  • System administrators
  • All users

Additional Information

Contribution

  • I can contribute a fix/improvement
  • I can review proposed changes
  • I need help from maintainers