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

Restructuring the Documentation (nitrokeys) #272

Closed
wants to merge 33 commits into from

Conversation

Keksmo
Copy link
Collaborator

@Keksmo Keksmo commented Jul 29, 2024

TODO:

  • restructure Nk3
  • restructure Passkey
  • restructure FIDO2
  • restructure U2F
  • restructure HSM
  • restructure Pro
  • restructure Start
  • restructure Storage
  • fix broken links
  • index and features files
  • redirects
  • proper ECC page
  • decide on order of Lists
  • decide on maxdepths
  • mark which products are compatible with which features

Known Issues:

  • 2fa structure
  • naming of some features
  • desktop-login images
  • openpgp links
  • totp general as index
  • replace FIDO u2f with u2f
  • combine harddiskencryption and luks
  • fix desktop login links
  • fix piv
  • find a way to structure nk3
  • what to do with linux in nk3
  • fix CI errors
  • fix build errors
  • is n-m schemes only linux?
  • maybe remove main page in nk3
  • toctrees on the side

@daringer daringer marked this pull request as draft July 29, 2024 12:06
@Keksmo Keksmo changed the title [DRAFT] Restructuring the Documentation [DRAFT] Restructuring the Documentation (nitrokeys) Jul 31, 2024
@Keksmo Keksmo changed the title [DRAFT] Restructuring the Documentation (nitrokeys) Restructuring the Documentation (nitrokeys) Aug 14, 2024
@Keksmo Keksmo marked this pull request as ready for review August 14, 2024 11:53
@DamienCassou
Copy link

This seems to be a huge piece of work. Any reason for not merging it?

Thank you so much for writing awesome documentation.

@jans23
Copy link
Member

jans23 commented Oct 17, 2024

As you said, it's a huge piece of work and it's work in progress. Specifically, it requires restructuring the CI workflows too which is what we are currently working on.

@daringer
Copy link
Contributor

closing in favor of #309

@daringer daringer closed this Oct 29, 2024
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.

4 participants