docs: add VitePress documentation site at ldelements.org#664
Open
ddeboer wants to merge 1 commit into
Open
Conversation
- Add a VitePress site under docs/ with a Guide and a Reference for all 26 packages - Migrate README content into docs/reference; slim READMEs to a summary plus docs link (ADR 17) - Audit all packages and four consumer projects; fix stale claims and document missing options - Deploy to GitHub Pages from docs.yml with the ldelements.org custom domain - Fail the docs build on dead links and run it as a PR check - Render Mermaid diagrams hand-drawn; add sitemap and local search - Record the documentation policy in AGENTS.md and CONTRIBUTING.md
ddeboer
force-pushed
the
docs/documentation-site
branch
from
July 25, 2026 19:41
536196a to
8cdc2f0
Compare
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.
Adds a VitePress documentation site under
docs/, deployed to https://ldelements.org, and makes it the single source of truth for all documentation.Site
Content migration (ADR 17)
docs/reference/<package>.md; READMEs slimmed to description, installation, at most one example, and a link to the package’s docs page (3,223 → 630 lines total). npm pages stay accurate because they contain little that can go stale.Completeness audit
All packages and four consumer projects (Dataset Register, Dataset Knowledge Graph, LODA pipeline, Linked Open Limburg) were audited against the docs; every finding was verified against source before fixing. Highlights:
pipeline-shacl-samplertimeout), an outdatedItemSelectorsignature, stale ‘Executor’ terminology, a materialized view that is now a table, a false log-streaming claim, and schema examples that failed the indexer at boot (missingpath).Stage.project, reader template substitution,SparqlUpdateWritersemantics, writer fan-out and standalone use, failure isolation, the fullProgressReporterevent table,createQlever()options incl. native mode and the absolute-dataDirrequirement (createQlever({mode:'docker'}) silently fails without dataDir (no bind-mount, wrong workdir) #638), QLever’s supported dump formats, registry criteria operators, verdict contracts,maxFacetValues, range facets, the GraphQL pagination contract, and a working TypeScript schema-module bundling recipe.check(), volume writability) is ported into the docs, since the READMEs that carried it are slimmed here.Deployment
.github/workflows/docs.ymlbuilds the site on every PR (the build fails on dead links) and deploys to GitHub Pages on pushes tomain.ldelements.orgcustom domain attached; DNS already points at GitHub Pages, so the first deployment after merge goes live. HTTPS enforcement follows once the certificate is issued.