Skip to content

Clean up repository documentation and notebook navigation - #8

Merged
tulik merged 1 commit into
mainfrom
chore/repository-cleanup
Oct 16, 2026
Merged

tulik merged 1 commit into
mainfrom
chore/repository-cleanup

Conversation

@tulik

@tulik tulik commented Oct 16, 2026

Copy link
Copy Markdown
Member

The README repeated Jupyter setup and mixed three notebook workflows, making the starting point and source of truth difficult to find. Historical migration notes also presented old verification details without a clear archive label.

This cleanup:

  • Shortens the README and adds task-oriented navigation and a command reference.
  • Adds a documentation index and one notebook guide covering setup, canonical sources, working copies and static book rendering.
  • Clarifies contributor responsibilities and the build sequence, with a Mermaid diagram.
  • Labels historical records and distinguishes certificate validation from an independent operator trust review.

Build scripts, image recipes, executable notebooks and CI configuration are unchanged.

Validation: make check passed all 47 tests plus source and shell checks; existing tests checked local documentation links. git diff --check passed. The test suite emits existing subprocess ResourceWarnings. OS image construction, VM boot and live FreeIPA enrollment were not run for this documentation-only change.

@tulik
tulik merged commit e38cd18 into main Oct 16, 2026
7 checks passed
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