Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

add section for development docs

Open
  • Is something wrong?
#9 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
bun, docker, javascript, tailwindcss, typescript, vite
Domain
developer-experience, documentation

Research direction

Start by reviewing the BlueOS development docs linked in the issue and inspect the repository structure, .devcontainer, and deployment workflow. Done means adding a development documentation section covering the listed technologies, application model, repository structure, contribution guidance and restrictions, and communication channels.

Written by the indexing model from the issue text.

Description

enhancement
  • Can take inspiration from the BlueOS development docs
  • Should cover things like:
    • Tech stack
      • Tailwind, vite, bun, Docker, TypeScript, Vuetify, etc.
      • Browser-based vs standalone application
      • .devcontainer
      • Repo structure
      • Deployment workflow
    • How to contribute (code, docs, ideas), and restrictions on doing so (license(s), contributor covenant)
    • Communication channel(s)
    • #1
Dominant language
JavaScript
Stars
4
Forks
3
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from bluerobotics/Cockpit-docs

All issues in bluerobotics/Cockpit-docs

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.