Skip to content

Sync API docs from bc3: example fixes and join-a-project wording - #447

Merged
jorgemanrubia merged 1 commit into
masterfrom
sync-docs-fixes
Sep 17, 2026
Merged

jorgemanrubia merged 1 commit into
masterfrom
sync-docs-fixes

Conversation

@jorgemanrubia

Copy link
Copy Markdown
Member

This syncs bc3's doc/api/ at master 2ee862e469 to bump the mirror. It carries two things and nothing else: no other team's unsynced doc changes show up in the copy.

  • Fixes Copilot found on Sync API docs from bc3 #446 (bc3#13388):
    • card_table_templates.md and template_library.md now show the response before the cURL, and the copy example uses the same id in its request and response.
    • event_feed.md: its three HTTP response examples now have route markers.
    • timeline.md: performed_by is Agent, or Tombstone once the agent is deleted.
  • Later wording for Join a project (bc3#13389), following Document joining an all-access project (POST /buckets/:id/admissions.json) #437:
    • people.md now says "has access to" instead of "has joined".
    • Only a token acting as the agent itself gets 403.
    • "Update who can access a project" manages the people you name.

After this, sections/ and README.md match bc3 doc/api/ exactly.

Synced from bc3 doc/api/ by script/api/sync_to_bc3_api — not a hand-edit.

Copilot AI balanced review requested due to automatic review settings September 17, 2026 05:53

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟢 Approved

The synchronized documentation changes are consistent, correctly marked, and match the stated scope.

Pull request overview

Syncs authoritative bc3 API documentation updates into this mirror.

Changes:

  • Aligns template request/response examples and ordering.
  • Adds missing event-feed route markers.
  • Clarifies project access and deleted-agent behavior.

[!TIP]
If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.

File summaries
File Description
sections/card_table_templates.md Corrects example ordering and identifiers.
sections/event_feed.md Adds response route markers.
sections/people.md Clarifies project access and agent-token behavior.
sections/template_library.md Aligns names, ordering, and copy IDs.
sections/timeline.md Documents tombstones for deleted agents.
Review details
  • Files reviewed: 5/5 changed files
  • Comments generated: 0
  • Review effort level: Balanced

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@jorgemanrubia
jorgemanrubia merged commit 1fc8038 into master Sep 17, 2026
1 check passed
@jorgemanrubia
jorgemanrubia deleted the sync-docs-fixes branch September 17, 2026 05:55
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