Repository navigation
docs(website): add the documentation home website - #1
Merged
Merged
Conversation
An Astro and Starlight website at the repository root, copied from the Allors Excel documentation tooling at allors/excel@042f2a4 and adapted for the home: site.mjs holds the title, the description, the version label main, the origin https://docs.allors.com, the base path / and the list of documentation areas; the sidebar links to the areas as absolute URLs; the source-link rewrite resolves the repository root one level above integrations/; the link checker leaves links into the areas to their own builds and counts them; the workflow validates one base path at the repository root and publishes only on a manual run with publish selected. Two pages: the index, which describes each area in that area's own published words and links to its documentation, Markdown index and agent index; and the documentation home decision record, with the reason the repository keeps the name of the organisation site, what was reused, the validation and the publication steps. Validation on 2026-10-19: npm test (22 tests), npm run check (0 errors), npm run build (2 Markdown exports and llms.txt), npm run check:links (82 links, 0 errors, 44 links into the areas left to their builds) and npm run test:browser (12 tests at desktop and narrow widths, including axe WCAG 2 A and AA). Nothing is published: the repository stays private, Pages is not enabled and no domain is configured.
The agent instructions and the decision record said not to name unpublished Allors projects, which itself told readers that such projects exist; both now say nothing outside the home's public scope. The record's status note no longer asserts the hosting state, which changes within minutes of the merge; it points to the publication steps and says when the record becomes current. The verification step names the apex domain: GitHub's documentation, consulted on 2026-10-19, says that verifying a domain also verifies its immediate subdomains, so one TXT record at allors.com covers docs.allors.com.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Allors documentation home: an Astro and Starlight website at the repository root, to be served at
https://docs.allors.com, beneath which Allors3, Documents, Excel and Immersive publish their own documentation from their own repositories.What the website is
site.mjsholds the title, the description, the version labelmain, the originhttps://docs.allors.com, the base path/and the list of areas; the sidebar links to the areas as absolute URLs; the source-link rewrite resolves the repository root one level aboveintegrations/; the link checker leaves links into the areas to their own builds and counts them; the workflow validates a single base path at the repository root and publishes only on a manual run withpublishselected.internals/documentation-home: why the repository keeps the nameallors.github.io(only an organisation site's custom domain is inherited by the project sites, so a repository nameddocs.allors.comwould leave the areas atallors.github.io/<repository>/), the Free-plan constraint, what was reused, the validation and the publication steps in order.README.mdandAGENTS.mdfor maintainers and agents; the home names only Allors3 and the supporting open-source tools.Validation
Run on 2026-10-19 at the repository root for the base path
/:npm test: 22 tooling tests, including a new test for links into the areas.npm run check: 0 errors.npm run build: 2 Markdown exports andllms.txt; the exportedindex.mdcarries the table of the areas with absolute links to their Markdown indexes and agent indexes.npm run check:links: 82 links across 6 files, 0 errors; 44 links into the areas left to their builds.npm run test:browser: 12 tests at desktop and narrow widths: keyboard navigation, the sidebar links to every area, search, the Mermaid diagram in both themes, focusable code blocks and axe WCAG 2 A and AA.Not in this pull request
Nothing is published. The repository stays private, Pages is not enabled and no domain is configured; those steps follow in order once this is merged, as the decision record lists.
Review
The index describes the areas; the opening sentence and the descriptions are the text that goes public first. The descriptions are taken from each product's README and documentation index.