Skip to content

Conversation

@kacpersaw
Copy link
Contributor

@kacpersaw kacpersaw commented Feb 4, 2026

Summary

Restructures the README to match the style of the main coder/coder repository for consistency.

Closes #162

Changes

  • Centered header with title, tagline, navigation links, and badges
  • Reorganized sections for better flow:
    • Installation → Configuration → Template Setup → Development → How It Works → Support
  • Consolidated configuration under one section (Helm values, CLI flags/env vars, custom certificates)
  • Added Makefile targets section for contributors
  • Added Support section with links to GitHub issues and Discord
  • Fixed release badge URL (was incorrectly pointing to envbuilder repo)

@kacpersaw kacpersaw force-pushed the kacpersaw/update-readme branch 2 times, most recently from 2b2df0d to 3afa670 Compare February 4, 2026 14:26
@kacpersaw kacpersaw changed the title docs: expand README with CLI flags and Makefile targets docs: restructure README to match coder/coder style Feb 4, 2026
@kacpersaw kacpersaw force-pushed the kacpersaw/update-readme branch from 3afa670 to 0be97ce Compare February 4, 2026 14:27
- Add centered header with navigation links
- Reorganize sections: Installation, Configuration, Template Setup, Development, How It Works
- Consolidate all config (namespaces, CLI flags, certificates) under Configuration
- Add Helm values section with namespace example
- Add Makefile targets for contributors
- Add Support section with issue/Discord links
- Move 'How It Works' to end (implementation detail)
- Fix release badge URL to point to correct repo
@kacpersaw kacpersaw force-pushed the kacpersaw/update-readme branch from 0be97ce to 6b4f330 Compare February 4, 2026 14:30
@kacpersaw kacpersaw marked this pull request as ready for review February 5, 2026 09:51
@kacpersaw kacpersaw force-pushed the kacpersaw/update-readme branch from 0cf032a to d8eee4c Compare February 5, 2026 12:15
@kacpersaw kacpersaw merged commit 89272db into main Feb 5, 2026
4 checks passed
@kacpersaw kacpersaw deleted the kacpersaw/update-readme branch February 5, 2026 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Restructure the README to match the style of the main coder/coder repository

2 participants