Documentation for advanced DCS features (picture password, TPM, hidden OS, ...)

Open
#1,847 6 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Domain
documentation

Research direction

Start by reviewing the linked documentation repository, https://github.com/kFYatek/veracrypt-missing-docs/, and the existing official resources the issue proposes updating. The issue asks whether to link or incorporate these guides and requests contribution guidelines; done means an agreed official integration path, but no target files or tests are identified here.

Written by the indexing model from the issue text.

Description

I took the liberty of writing my own documentation, with step-by-step guides, for all those features that have been in the codebase since 2017, but never integrated with the GUI, and only barely documented with those cryptic PDF files written by @kavsrf and other community efforts on Sourceforge.

Here are my documentation efforts: https://github.com/kFYatek/veracrypt-missing-docs/

I'm mostly just putting it out, but if you want to link to it from any official resources, or incorporate it therein, feel free to do so in any way you feel appropriate. If you want me to remake it into a pull request for example, I'd be glad for some guidelines on that.

Dominant language
C
Stars
11.7k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
28

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from veracrypt/VeraCrypt

All issues in veracrypt/VeraCrypt

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.