Skip to content

docs(website): publish at https://docs.allors.com/excel/ - #28

Merged
koenvanexem merged 1 commit into
mainfrom
docs/documentation-home
Oct 19, 2026
Merged

koenvanexem merged 1 commit into
mainfrom
docs/documentation-home

Conversation

@koenvanexem

Copy link
Copy Markdown
Member

The documentation website is published beneath the Allors documentation home, at
https://docs.allors.com/excel/. The custom domain is configured on the organisation site
allors/allors.github.io and applies to this project site, so the deployment origin changes from
https://allors.github.io to https://docs.allors.com in docs/site.mjs, in the link checker's
default and in the documentation workflow's DOCS_SITE; the base path /excel/ is unchanged.

The sidebar's first entry, "Allors documentation", links to the home at the root of the origin. The
link is home in site.mjs, derived from site so that DOCS_SITE changes it as well. The link
checker leaves that link to the home's own build when it lies outside the deployment base, counts
it as unchecked and reports the count; every other same-origin link outside the base remains an
error. The repository's Pages source is GitHub Actions, with the github-pages environment
deploying from main. The decision record and the documentation index become Current, and the
website instructions describe the published state. The record does not become Historical, as its remaining work proposed: it still describes the
website's present design and hosting, and the writing guide reserves Historical for a record whose
current truth lives on another page.

Tests: the link checker's fixtures use the new origin, a tooling test covers the link to the home
beneath /excel/ and at /, and a browser test checks the sidebar link. Validated on 2026-10-19
from docs/: npm test, npm run check, npm run build, npm run check:links and
npm run test:browser at /excel/, and npm run build and npm run check:links at /; the
Documentation workflow validates both base paths on this pull request. The change is the same in
the allors3, documents, excel and immersive repositories, so that the copies of the tooling stay
identical.

The documentation website is published beneath the Allors documentation home, at
`https://docs.allors.com/excel/`. The custom domain is configured on the organisation site
`allors/allors.github.io` and applies to this project site, so the deployment origin changes from
`https://allors.github.io` to `https://docs.allors.com` in `docs/site.mjs`, in the link checker's
default and in the documentation workflow's `DOCS_SITE`; the base path `/excel/` is unchanged.

The sidebar's first entry, "Allors documentation", links to the home at the root of the origin. The
link is `home` in `site.mjs`, derived from `site` so that `DOCS_SITE` changes it as well. The link
checker leaves that link to the home's own build when it lies outside the deployment base, counts
it as unchecked and reports the count; every other same-origin link outside the base remains an
error. The repository's Pages source is GitHub Actions, with the `github-pages` environment
deploying from `main`. The decision record and the documentation index become Current, and the
website instructions describe the published state. The record does not become Historical, as its remaining work proposed: it still describes the
website's present design and hosting, and the writing guide reserves Historical for a record whose
current truth lives on another page.

Tests: the link checker's fixtures use the new origin, a tooling test covers the link to the home
beneath `/excel/` and at `/`, and a browser test checks the sidebar link. Validated on 2026-10-19
from `docs/`: `npm test`, `npm run check`, `npm run build`, `npm run check:links` and
`npm run test:browser` at `/excel/`, and `npm run build` and `npm run check:links` at `/`; the
Documentation workflow validates both base paths on this pull request. The change is the same in
the allors3, documents, excel and immersive repositories, so that the copies of the tooling stay
identical.
@koenvanexem
koenvanexem merged commit 1bffe97 into main Oct 19, 2026
6 checks passed
@koenvanexem
koenvanexem deleted the docs/documentation-home branch October 19, 2026 14:49
koenvanexem added a commit to allors/allors.github.io that referenced this pull request Oct 19, 2026
The four documentation areas are published beneath the home: Allors3 at `/allors3/`, Documents at
`/documents/`, Excel at `/excel/` and Immersive at `/immersive/`, each from its own repository by
its own Documentation workflow, after the pull requests allors/allors3#286, allors/documents#11,
allors/excel#28 and allors/immersive#2 switched their deployment origin to
`https://docs.allors.com` and gave each sidebar a first entry back to the home. The decision record
becomes Current: its status line, scope and Free-plan sentences describe the published state, the
publication steps are recorded as taken on 2026-10-19, with the areas' step completed, and a
paragraph says that the custom domain of the organisation site applies to every project site, so
that an area needs no domain configuration of its own, and that HTTPS is enforced on the domain.
The website instructions describe the published state in the same way. The index is unchanged; its
links into the areas now resolve.

Validation on 2026-10-19, after the four areas were published: at `https://docs.allors.com`, the
home and every area answer 200 for their page, `index.md` and `llms.txt`; `http://` addresses
redirect to `https://`; `https://allors.github.io/` and `https://allors.github.io/<area>/` redirect
to the domain; a browser walks home → area → home for the four areas through the sidebar links
without page errors; the published output names nothing outside the public scope. At the
repository root: `npm test`, `npm run check`, `npm run build`, `npm run check:links` and
`npm run test:browser`; the Documentation workflow validates this pull request.
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