Skip to content

Latest commit

 

History

471 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

vdoc

Pipeline Coverage PyVersions PyPI Ruff uv Checked with mypy

Multi version documentation hosting.

See it in action

The vdoc instance serving the voraus robotik GmbH software documentation is available at docs.vorausrobotik.com.

AI and agent ready

Documentation is read by crawlers, link checkers and coding agents as much as by people, and a JavaScript application tells them nothing. vdoc therefore publishes what it holds in three files such a client already looks for, all generated from what is actually published:

/llms.txt Every project at its newest version, linked at the address that serves real HTML, plus the machine-readable page index each version ships
/sitemap.xml The same entry points as a sitemap, dated by when each version was published
/robots.txt Allows everything, and points at both of the above

llms.txt follows the llms.txt convention, sitemap.xml the sitemaps protocol, and robots.txt the Robots Exclusion Protocol (RFC 9309).

A page requested at its readable address answers with a Link header naming the static address that carries it, so a client that started from a link a person shared finds the content from the response it already has. And an agent is told which of the two addresses to quote back: the readable one.

See Agent and crawler discovery for how it works and what it contains.

Documentation

Please read the documentation for more a more detailed introduction.

Releases

Packages

Used by

Contributors

Languages