Skip to content

docs: fix documentation issues found during newbie testing#10

Merged
yangbooom merged 1 commit intomainfrom
fix/documentation-issues-0116
Jan 16, 2026
Merged

docs: fix documentation issues found during newbie testing#10
yangbooom merged 1 commit intomainfrom
fix/documentation-issues-0116

Conversation

@yangbooom
Copy link
Contributor

Summary

  • Fix health endpoint response: "ok""healthy"
  • Fix ready endpoint response structure to match actual API
  • Add MinIO to Docker Compose services list in quick start
  • Fix Go version requirement: 1.251.24 (matches go.mod)
  • Update Docker image docs to build locally (image not published)
  • Add nested namespace URL documentation (dot-separated and %1F)
  • Create pull-requests.mdx with PR submission guidelines
  • Update contributing meta.json to include pull-requests page

Test plan

  • Verify docs site builds without errors
  • Check quick-start page shows correct health/ready responses
  • Check installation page shows Go 1.24 and local Docker build instructions
  • Check first-steps page has nested namespace URL documentation
  • Check pull-requests page is accessible from sidebar

- Fix health endpoint response: "ok" → "healthy"
- Fix ready endpoint response structure to match actual API
- Add MinIO to Docker Compose services list in quick start
- Fix Go version requirement: 1.25 → 1.24 (matches go.mod)
- Update Docker image docs to build locally (image not published)
- Add nested namespace URL documentation (dot-separated and %1F)
- Create pull-requests.mdx with PR submission guidelines
- Update contributing meta.json to include pull-requests page

Fixes issues documented in issues_0116.md
@yangbooom yangbooom merged commit 7c0715d into main Jan 16, 2026
2 checks passed
@yangbooom yangbooom deleted the fix/documentation-issues-0116 branch January 16, 2026 07:29
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.

1 participant