Skip to content

Commit ac8e82c

Browse files
committed
Clarify blog backlink requirements in CONTRIBUTING.md and ONBOARDING.md, specifying conditions for live or scheduled articles. Update README.md to reflect these changes for consistency.
1 parent 894b2a0 commit ac8e82c

3 files changed

Lines changed: 7 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,14 @@ The public quality bar focuses on usefulness and honesty:
3737

3838
- Correct CaptchaAI API endpoints and parameter usage
3939
- Clear setup instructions and environment configuration
40-
- A working blog backlink for context
40+
- A canonical blog backlink for context when the article is live or scheduled for imminent publication, or an explicit pending-publication note when it is not
4141
- Lint or compile checks where toolchains are available
4242
- Deeper runtime or smoke validation on selected reference flows
4343

4444
The private owner repo also regenerates the root README index, checks cross-repo metadata truth, and validates support-tier claims before treating the public repo as healthy.
4545

46+
Do not point users at missing or unknown `blog.captchaai.com` URLs from this public repo. Scheduled canonical links are acceptable when publication is imminent.
47+
4648
## External contributions
4749

4850
This repository is not running a broad external contribution workflow right now. If that changes, this file will be updated.

ONBOARDING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ If you are onboarding, start here before editing pack content or changing repo-l
77
## What this repo is for
88

99
- publish client-facing runnable example packs
10-
- help readers move from a blog article to working CaptchaAI code fast
10+
- help readers move from a live blog article to working CaptchaAI code fast
1111
- state support levels honestly
1212
- give clients a stable pack-level contract through `articles/{slug}/README.md`
1313

@@ -44,7 +44,7 @@ Do not treat internal generation history as part of the public contract.
4444
| Public surface | Private source or owner |
4545
|---|---|
4646
| `articles/{slug}/` | article slug and example metadata in `cai_content` |
47-
| Pack README backlink | blog article at `https://blog.captchaai.com/{slug}` |
47+
| Pack README backlink | canonical blog article at `https://blog.captchaai.com/{slug}` when the article is live or scheduled for imminent publication |
4848
| Root README index | generated from private manifests and validation |
4949
| Support tier | private example-factory validation and reporting |
5050

@@ -82,6 +82,7 @@ The private factory also checks:
8282
3. Do not hand-edit the generated root README index unless you are intentionally repairing it and regenerating immediately after.
8383
4. Keep pack README setup steps aligned with the actual files in that pack.
8484
5. If a language is listed, that implementation should exist and be usable as documented.
85+
6. Scheduled articles that are about to publish may keep the canonical blog backlink, but missing or unknown blog targets should still use a pending-publication note.
8586

8687
## Start-here order
8788

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Public code examples for the [CaptchaAI](https://captchaai.com) CAPTCHA solving API.
44

5-
This repository is published for clients who want a runnable starting point fast. Each pack links back to a blog article, includes setup instructions, and shows the current support level honestly.
5+
This repository is published for clients who want a runnable starting point fast. Each pack includes setup instructions, shows the current support level honestly, and links back to the companion blog article once that article is live or scheduled for imminent publication.
66

77
For maintainers, start with `ONBOARDING.md` before changing repo-level messaging or pack contracts.
88

0 commit comments

Comments
 (0)