Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Research more sustainable documentation pipelines #828

Closed
yezr opened this issue Apr 22, 2024 · 1 comment
Closed

Research more sustainable documentation pipelines #828

yezr opened this issue Apr 22, 2024 · 1 comment
Assignees

Comments

@yezr
Copy link
Collaborator

yezr commented Apr 22, 2024

Currently we use one giant google doc to draft our TDP. Let's research some more sustainable ways to build documentation.

Must haves

  • Simple offline access for use in air gapped environment
  • Easily configure and provision multiple editors
  • Easily see edit history
  • Multiple “production” versions - for each RCTab version
  • Easily printable PDF for hard copy (election admins love a printed copy 🙃)
  • Navigation links within the document

Nice to Have

  • Documentation versioning linked to code versioning
  • One source of truth that can be pushed out to different documentation locations (in-app hints, TDP, User Guide)
  • On-the-fly configurable per audience
    • Depending on your vendor, remove unnecessary information about other vendors or unnecessary configuration options
    • STV vs IRV also filters configuration options
    • Election Admin vs. Certification Body

Options

@yezr yezr self-assigned this Apr 22, 2024
@yezr
Copy link
Collaborator Author

yezr commented Jun 12, 2024

done, we're going with mkdocs.

@yezr yezr closed this as completed Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

1 participant