Physlib

Documentation Tracker

The graph below shows the documentation status of Physlib files. Red nodes need documentation; green nodes are documented. Click nodes to navigate to their GitHub entry.

Graph controls: drag to pan, scroll / pinch to zoom.

Loading graph…

Steps to Help with Documentation

This whole process can be done without downloading Lean, but having it installed provides helpful tools.

Phase 1: Get the Code

  1. Fork the physlib GitHub repository (copy the master branch only).
  2. Clone your forked repository to your local machine. (Optional — you can also edit directly on GitHub.)

Phase 2: Choose a File to Document

  1. Use the graph above to identify an undocumented file (a red node) where you think you could help.
  2. In your local copy of physlib, open the file ./scripts/MetaPrograms/module_doc_no_lint.txt.
  3. Remove the line corresponding to the file you want to document.
  4. Navigate to the file you want to document.

Phase 3: Write the Documentation

  1. Add a title heading at the top of the file, starting with # .
  2. Add a ## i. Overview section explaining the physical content.
  3. Add a ## ii. Key results section listing key definitions, theorems, and lemmas.
  4. Add a ## iii. Table of contents section (can be left blank).
  5. Add a ## iv. References section for relevant literature.
  6. Organize the rest of the file with section and subsection headings.
  7. Alternatively, if you have Lean installed, run lake exe module_doc_lint.

Phase 4: Submit Your Changes

  1. Commit your changes to your forked repository.
  2. Create a pull request to the main physlib repository for review.