Skip to content

docs: adjust docs for quicker start#62

Merged
giorgi-pro merged 11 commits intomainfrom
docs/gom-20-simplify-gomodel-readme-with-docker-first-quick-start
Feb 9, 2026
Merged

docs: adjust docs for quicker start#62
giorgi-pro merged 11 commits intomainfrom
docs/gom-20-simplify-gomodel-readme-with-docker-first-quick-start

Conversation

@giorgi-pro
Copy link
Copy Markdown
Collaborator

@giorgi-pro giorgi-pro commented Feb 9, 2026

  • Moved Docker docker run to the top as the primary Quick Start method, using the enterpilot/gomodel image with API keys passed via -e flags
  • Added a provider reference table (env var + example model) right below Quick Start
  • Moved "Running from Source" (make run) and "Docker Compose (Full Stack)" into a lower "Alternative Setup Methods" section
  • Added API Endpoints and Configuration reference sections
  • Removed the old golang:1.24-alpine + go run dev-mode Docker example in favor of the proper multi-stage built image
  • Removed OpenRouter from the providers list (no implementation exists)
  • Merged supported provider tables

Summary by CodeRabbit

  • Documentation
    • Rewrote Quick Start into a clear two-step Docker flow with examples and secret-handling guidance
    • Added Supported Providers table, API endpoints reference, Alternative Setup Methods, configuration/auth guidance, and updated Roadmap/Features/Integrations
    • Expanded developer docs with testing, linting, and pre-commit setup and simplified dev/test commands

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Feb 9, 2026

Warning

Rate limit exceeded

@giorgi-pro has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 17 minutes and 57 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📝 Walkthrough

Walkthrough

README.md and DEVELOPMENT.md were updated with expanded developer and setup documentation: README now replaces manual env setup with a Docker-first Quick Start, adds provider capability and API endpoint tables, alternative setup methods, configuration and auth guidance; DEVELOPMENT.md adds testing, linting, and pre-commit workflows. Changes are documentation-only.

Changes

Cohort / File(s) Summary
Documentation & Setup Guide
README.md
Full rewrite of Quick Start to a Docker Step 1/Step 2 flow (removes manual env export), adds docker run examples, Supported Providers capability table, API Endpoints, Configuration and Authentication guidance (GOMODEL_MASTER_KEY warning), Alternative Setup Methods (Running from Source, Docker Compose, local image build), Roadmap/Features/Integrations updates, and formatting/wording edits. No code changes.
Development Workflow
DEVELOPMENT.md
New development documentation: testing commands (make test, make test-e2e, make test-all), linting setup/commands (golangci-lint, make lint, make lint-fix), and pre-commit installation/use instructions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 I hopped through docs with eager paws and cheer,
Docker steps and tables now appear,
Keys tucked safe, endpoints set just right,
I nibble notes and dance into the night,
Tiny rabbit, proud to share this light.

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'docs: adjust docs for quicker start' is related to the changeset but is vague and doesn't clearly convey the main structural changes (Docker-first Quick Start, provider tables, section reorganization). Consider a more specific title that captures the primary change, such as 'docs: reorganize README with Docker-first Quick Start and provider reference table' to better describe the documentation restructuring.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/gom-20-simplify-gomodel-readme-with-docker-first-quick-start

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 15-48: Change the README wording that currently says "Pass only
the API keys you need" to a more accurate phrase such as "Pass only the provider
credentials or base URL you need" and update the surrounding examples and table
header so non-key credentials (e.g., OLLAMA_BASE_URL) are covered; specifically
edit the introductory sentence and the table column title "Environment Variable"
to something like "Credential / Env Variable" and ensure entries like
OPENAI_API_KEY, OLLAMA_BASE_URL, ANTHROPIC_API_KEY, GEMINI_API_KEY,
GROQ_API_KEY, XAI_API_KEY are all represented consistently.
- Around line 111-123: Add a short "Quick Start — Authentication" warning to the
README next to the environment variables table that calls out
GOMODEL_MASTER_KEY: state that by default there is no master key
(GOMODEL_MASTER_KEY is unset), this is insecure for production, and strongly
recommend setting a strong secret before exposing the service; include a brief
example of intended behavior (e.g., "without this key, API endpoints are
unprotected") and a one-line instruction to set GOMODEL_MASTER_KEY in the .env
or environment for production deployments.
- Around line 9-24: Update the Docker usage examples to avoid encouraging
passing secrets on the command line: add a brief explicit warning that
environment variables on the CLI can leak via shell history and process lists,
and recommend using docker --env-file or a .env file (or docker run --env-file)
to load API keys instead; update the examples around the docker run snippets and
mention that at least one API key is required while pointing readers to the
safer --env-file approach.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 88-93: Update the "Building the Docker Image Locally" Quick Start
section to use the safer .env file approach (as shown in the "Alternative Setup
Methods" section) instead of demonstrating passing secrets via docker run -e;
change the Quick Start steps under the "Building the Docker Image Locally"
heading to instruct creating a .env with GEMINI_API_KEY and running docker run
--env-file, and move the direct -e flag example (plus a clear security warning
about exposing secrets) into the "Alternative Setup Methods" section where the
.env pattern currently appears.

Copy link
Copy Markdown
Contributor

@SantiagoDePolonia SantiagoDePolonia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, it looks better than the previous version! I've left a few comments.

giorgi-pro and others added 2 commits February 9, 2026 22:45
Co-authored-by: Jakub A. Wąsek <jakubwasek@gmail.com>
- clean up terms used
- use openai for examples
- extract development docs
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@DEVELOPMENT.md`:
- Around line 5-9: Update the DEVELOPMENT.md entry for the make test-e2e target
to note that it builds with the -tags=e2e build tag and runs using in-process
mock servers (no Docker); specifically edit the make test-e2e line so its
comment reads something like "End-to-end tests (requires -tags=e2e; uses
in-process mock servers, no Docker)" to match the Makefile behavior and project
testing guidelines.

In `@README.md`:
- Around line 45-101: Replace the retired Anthropic model identifier
"claude-3-5-sonnet-20241022" with "claude-sonnet-4-20250514" in the table row
for Anthropic, and add a short disclaimer line above the table such as "Example
model identifiers are illustrative and subject to change; consult provider
catalogs for current models." to indicate model freshness (refer to the
Anthropic model string and the table block containing provider rows).


---

## Alternative Setup Methods
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the future we can move this section to the development as well. From the person who want to try the project and use it for the first time it is not necessary.

We also need to have a "Quick Start" page on the docs website. It will be a little bit more detailed and different.

Copy link
Copy Markdown
Contributor

@SantiagoDePolonia SantiagoDePolonia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a good improvement!

@giorgi-pro giorgi-pro merged commit 79b0c32 into main Feb 9, 2026
11 checks passed
@giorgi-pro giorgi-pro deleted the docs/gom-20-simplify-gomodel-readme-with-docker-first-quick-start branch February 9, 2026 22:39
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.

2 participants