Redesign documentation (full workflow)#274
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #113.
Complete from-scratch redesign of the documentation, built for both newcomers and advanced users — and in particular for contributors whose background is physics rather than software.
Why
The previous 4-page
docs/were badly out of date: wrong repo name (cms-flaf/Framework), every task name obsolete, the wrong "clone FLAF standalone" entry-point model, Run 2-centric, HH_bbtautau-only, no concepts/caveats/glossary, and a brokenmkdocs.yml(fonts.css).What
A layered MkDocs/Material site (~25 pages): Getting started, Concepts (architecture, LAW/tasks, data flow, config, eras, storage, environment), the full-workflow walkthrough + HTCondor + arguments, a configuration guide, a per-task reference, CI/CD, troubleshooting, glossary, contributing, and an analyses index. Every command, task name, parameter,
fs_*key and config field was checked against the current code.The framework workflow is documented once here; each analysis repo gets a thin supplement (separate PRs, same branch name
issue-113-docs-redesign).Also fixes the stale
README.mdtitle and adds a GitHub Pages deploy workflow (.github/workflows/deploy-docs.yaml).Testing
mkdocs build --strictpasses with no warnings (fails on any broken link/nav/asset);mkdocs.ymlpassesyamllint.