Generate Salesforce Project Documentation

How to generate

• Use the git repository containing your SFDX project, or create it easily with sfdx-hardis Monitoring, or simply by calling the Backup command

• Activate AI integration (optional but recommended)

• In the VS Code SFDX Hardis extension, run the command Documentation Generation > Generate Project Documentation (with history)
  • Corresponding command line: sf hardis:doc:project2markdown --with-history

Here is a click-by-click tutorial to generate your documentation locally (once you are convinced, the best option is to let sfdx-hardis Monitoring generate it for you):

Run Locally

• Run command Documentation Generation > Run local HTML Doc Pages (Note: you need Python on your computer)
  • Corresponding command lines: pip install zensical mdx_truly_sane_lists, then zensical serve
  • Alternative 1: python -m pip install zensical mdx_truly_sane_lists, then python -m zensical serve
  • Alternative 2: py -m pip install zensical mdx_truly_sane_lists, then py -m zensical serve

• Open http://127.0.0.1:8000/ in your web browser

Comments