Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Biscuit Documentation #418

Open
3 of 39 tasks
tomlin7 opened this issue Oct 13, 2024 · 0 comments
Open
3 of 39 tasks

Biscuit Documentation #418

tomlin7 opened this issue Oct 13, 2024 · 0 comments
Assignees
@tomlin7
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue good for newcomers

Comments

@tomlin7
Copy link
Owner

tomlin7 commented Oct 13, 2024 •
edited
Loading

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 tomlin7 added the enhancement New feature or request label Oct 13, 2024
@tomlin7 tomlin7 self-assigned this Oct 13, 2024
@tomlin7 tomlin7 added documentation Improvements or additions to documentation good first issue good for newcomers labels Oct 13, 2024
@tomlin7 tomlin7 mentioned this issue Oct 13, 2024
Merged
@tomlin7 tomlin7 pinned this issue Oct 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tomlin7 tomlin7

Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tomlin7