Skip to content

docs: refresh orglabeler deployment docs - #6

Merged
Kzoeps merged 2 commits into
mainfrom
docs/certified-one-readme
Jun 26, 2026
Merged

docs: refresh orglabeler deployment docs#6
Kzoeps merged 2 commits into
mainfrom
docs/certified-one-readme

Conversation

@Kzoeps

@Kzoeps Kzoeps commented Jun 25, 2026

Copy link
Copy Markdown
Collaborator

Environment variable keys were changed: use LABELER_IDENTIFIER and LABELER_PASSWORD instead of the old Bluesky-specific names. Existing deployments need their service variables updated before relying on setup/sync scripts.

Summary

  • update README, deployment, Railway, app docs, and agent docs for current OrgLabeler runtime and endpoints
  • distinguish the labeler account identifier from the public app/labeler endpoint
  • rename labeler account env vars to LABELER_IDENTIFIER / LABELER_PASSWORD
  • remove the stale fork migration plan and hb/heartbeads agent instructions
  • add agent guidance to check and maintain the docs list when behavior changes
  • avoid naming signing algorithms in public docs

Checks

  • npm run test
  • npm run build
  • npx tsc --noEmit
  • local isolated Tap stack smoke: Docker Tap --outbox-only + isolated app DBs/ports reached Tap consumer started

@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The PR updates example environment values, quick-start/setup snippets, scoring and label-flow documentation, deployment and Railway configuration docs, and developer workflow guidance. It also removes the Fork Migration Plan document.

Changes

Labeler docs and configuration refresh

Layer / File(s) Summary
Bootstrap examples
README.md, .env.example, src/labeler/setup.ts
Example environment values, the quick-start setup command, and the labeler setup comment/log text use the updated handle, endpoint, and signing-key wording.
Runtime behavior docs
README.md, src/app/docs/page.tsx
The README and app docs rewrite the labeler architecture, scoring, async URL enrichment, record merge, and signed-label descriptions.
Deployment environment docs
DEPLOYMENT.md, RAILWAY.md, README.md
The deployment guides expand the app and Railway environment-variable tables and update persistence and SQLite path guidance.
Developer workflow docs
AGENTS.md, README.md
The repo guidance and README command list update the documented project tree, development commands, operational scripts, and remove the fork migration plan document.

🎯 3 (Moderate) | ⏱️ ~20 minutes

I hopped through envs with twitchy ears,
And found new labels, signs, and gears.
The docs now gleam, the paths align,
With carrot-bright config so fine. 🐇

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: a documentation refresh for OrgLabeler deployment-related files.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/certified-one-readme

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


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.

@Kzoeps
Kzoeps merged commit cda1007 into main Jun 26, 2026
3 checks passed
@Kzoeps
Kzoeps deleted the docs/certified-one-readme branch June 26, 2026 10:01
@sonarqubecloud

Copy link
Copy Markdown

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