Skip to content

Point people and coding agents at the site's own address, https://restest.org - #446

Merged
ssegura merged 1 commit into
masterfrom
docs/restest-org
Nov 11, 2026
Merged

ssegura merged 1 commit into
masterfrom
docs/restest-org

Conversation

@ssegura

@ssegura ssegura commented Nov 11, 2026

Copy link
Copy Markdown
Collaborator

Related: isa-group/restest-site#6, which serves the site at https://restest.org. This pull request is merged once https://restest.org serves the site, after isa-group/restest-site#6; it reaches people with the next release.

What you can do now that you could not before

Read RESTest's documentation at the site's own address, https://restest.org/docs/, and the list of its pages at https://restest.org/llms.txt: the README, the page for coding agents and the skill give them, so the sentence a person hands their coding agent names restest.org from the next release on. The old address, isa-group.github.io/restest-site, still leads there, so nothing that 2.5.0 says stops working.

Try it yourself

git fetch && git switch docs/restest-org
git grep -n 'isa-group.github.io/restest-site'
./mvnw -q verify -pl restest-arch-tests -am -Dtest='io.restest.arch.**' -Dsurefire.failIfNoSpecifiedTests=false && echo "the rules hold"
curl -s https://restest.org/llms.txt | head -1
docs/adr/0047-the-documentation-site.md:23:`https://isa-group.github.io/restest-site/docs/`. Its search runs in the browser, with no service,
the rules hold
# RESTest

How it works

The documentation site, isa-group/restest-site, has its own domain since today: GitHub Pages serves it at https://restest.org and sends every address under isa-group.github.io/restest-site/ on to the same page there. This change puts the new address wherever RESTest gives the site's, so that people and coding agents reach it directly, and so that the workflow that waits for the site to document a new release reads llms.txt there.

What changed in the code

  • README.md — the sentence for coding agents and the link to the documentation.
  • docs/for-coding-agents.md and skills/restest/SKILL.md — the same sentence, and where the documentation and llms.txt are; the page still ends with the skill word for word.
  • docs/ci.md — where the site publishes the documentation.
  • .github/workflows/documentation-site.yml — the comment at the top, and PUBLISHED, the llms.txt the job check-published waits for.
  • The paragraphs that got shorter are wrapped again at 100 columns.

Evidence

  • Tests: none added; the 162 tests of restest-arch-tests pass, DocumentedSkillTest (the page ends with the skill) and DocumentationSiteTest among them
  • Architecture tests: unchanged — none weakened
  • Mutation score: not applicable, no code touched
  • Per-request overhead: not applicable, no code touched
  • Smoke run: not applicable, no code touched
  • Idle time: not applicable, no code touched
  • Artefact: git grep above — the old address is left only in ADR-0047

Decisions taken

  • ADR-0047 keeps the address it was decided with. Decision records are history; the site's address is what changed, not the decision.
  • PUBLISHED names restest.org, not the old address. curl -fsSL follows the redirect, so either would work, but the new one does not depend on GitHub keeping it.

Open questions

None. The repository's website, in its About box, is a setting, changed apart from this pull request.


  • Targets master
  • English throughout, including comments and test names
  • The hard rules in AGENTS.md hold

🤖 Generated with Claude Code

…test.org

The README, the page for coding agents, the skill, docs/ci.md and the workflow that waits for the
site to document a release name https://restest.org instead of isa-group.github.io/restest-site.
ADR-0047 keeps the address it was decided with.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ssegura
ssegura merged commit c38ae58 into master Nov 11, 2026
11 checks passed
@ssegura
ssegura deleted the docs/restest-org branch November 11, 2026 12:13
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