Biscuit Documentation

[tomlin7]

This issue will keep track of the overall documentation progress of Biscuit - user docs, dev docs, extension dev docs, API reference. If you are contributing to writing docs, reference this issue in the PR! (like #418)

User docs

• quick start
• installation
• configuration
• usage
  • user interface
  • extensions
  • Text editor
  • Language features
  • Debuggers
  • Terminals
  • Source control
  • AI features
  • CLI
• Installing extensions
• building from source
• Reporting extensions
• ...

Dev docs (contributing)

• setting up environment
• styling guide
• overview of project sections
• The App/base class
• Editors module
• Views
• Layout module
• Common module
• Settings module
• Language Features
• Debugger
• Git
• CLI
• Extension API

Extension Development

• Getting started
  • Quick start
  • Adding language support
  • Adding Themes
• Extension API
• Testing
• Publishing

API Reference

• all modules

[tomlin7]

Will be split into sub issues.