Skip to content

docs: simplify public documentation - #70

Merged
dcajal merged 1 commit into
mainfrom
docs/unify-installation-and-api
Aug 12, 2026
Merged

docs: simplify public documentation#70
dcajal merged 1 commit into
mainfrom
docs/unify-installation-and-api

Conversation

@dcajal

@dcajal dcajal commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • reduce the public site to Home, Installation, and a direct API reference
  • replace hardcoded package versions with links to the latest GitHub release
  • move contributor guidance to a concise root CONTRIBUTING.md
  • make root CHANGELOG.md the single release-history source and derive GitHub release notes from it
  • remove duplicated module indexes, maintenance pages, and unused documentation plugins

Impact

Users get a shorter path from installation to function documentation and executable examples. Contributors retain the development and release information they need without exposing project-maintenance detail as public-site navigation.

Validation

  • pytest: 220 passed against the pinned Biosiglib commit
  • mkdocs build --strict
  • wheel and source-distribution build; CHANGELOG.md verified in the source distribution
  • release-note extraction and workflow YAML validation
  • git diff --check

@dcajal
dcajal merged commit 9320cd1 into main Aug 12, 2026
7 checks passed
@dcajal
dcajal deleted the docs/unify-installation-and-api branch August 12, 2026 11:36
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