Skip to content

Move the documentation from the wiki to a docs site - #96

Merged
timkpaine merged 2 commits into
mainfrom
tkp/docs-site
Oct 23, 2026
Merged

timkpaine merged 2 commits into
mainfrom
tkp/docs-site

Conversation

@timkpaine

Copy link
Copy Markdown
Member

The documentation moves from the GitHub wiki to a site built with yardang and published to GitHub Pages, as dau-scheduler and dau-core did.

  • Copier answers add_docs: true, add_wiki: false at the existing template commit, applied as rendered: the docs workflow replaces the wiki workflow, the Makefile's doc lints cover docs/src, and [tool.yardang] lists the pages in order.
  • The wiki's tutorial, how-to, reference and explanation pages move to docs/src with their links rewritten as relative paths. The template's install and contribute scaffold is replaced by how-to/develop.md, written for this repo: the native extension, the kernel drivers and make compile-unsigned for the dext, the hardware-test switches, cibuildwheel and building the site.
  • The README links the site and each page, and gains an install section (pip install dau-driver, where wheels exist, what a host with a board needs, and the device-permission trust model from the old Installation page) and a PyPI badge.
  • test_docs.py runs the two tutorials' Python blocks in order and checks every output they show; the how-to and reference pages are fragments for a real device. Fixing the one tutorial output that did not match: a blank line the code never prints.
  • Description "PCIe driver for dau projects", here and in the copier answers, replacing "PCIe Driver for dau".

A language pass took out the em dashes, the all-caps emphasis and a few stock constructions across the pages. Facts corrected on the way:

  • The README's example said read_status() returns link, MIG and operator-ready bits, and the transport-boundary page listed status bits among the layers; Read wire facts from dau-core and drop the undriven status bits #93 removed them.
  • find-a-device said hot paths are slower without the native extension. The extension only reports its backend and ABI version, so nothing runs differently without it.
  • The README's examples/ link and an anchor link into the device reference did not resolve on the site; the ScanBatch docstring split an inline literal in its autoapi summary.

yardang build succeeds with only yardang's own autoapi_ignore default and the READMEs outside the toctree (kernel, scripts) as warnings. make lint, make checks and the suite pass (219 passed, 3 skipped).

Signed-off-by: Tim Paine <3105306+timkpaine@users.noreply.github.com>
Signed-off-by: Tim Paine <3105306+timkpaine@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown

Test Results

222 tests  +3   219 ✅ +3   6s ⏱️ -1s
  1 suites ±0     3 💤 ±0 
  1 files   ±0     0 ❌ ±0 

Results for commit 887970c. ± Comparison against base commit 8f3583d.

@timkpaine
timkpaine merged commit 648b154 into main Oct 23, 2026
7 checks passed
@timkpaine
timkpaine deleted the tkp/docs-site branch October 23, 2026 19:50
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