Skip to content

Refresh the documentation landing page and the roadmap - #332

Merged
vahid-ahmadi merged 1 commit into
mainfrom
docs/refresh-landing-and-roadmap
Sep 18, 2026
Merged

vahid-ahmadi merged 1 commit into
mainfrom
docs/refresh-landing-and-roadmap

Conversation

@vahid-ahmadi

Copy link
Copy Markdown
Contributor

Three stale documents a JOSS reviewer reads early, found in a pre-submission review.

docs/home.md — the landing page said the API reference does not exist

In full, before this PR:

This includes example notebooks, and in the future will also include function documentation.

#324 added docs/api.md. So the first page of the documentation told a reader the function documentation was still to come. A reviewer scoring the "functional documentation" checkbox reads this page first.

It now says what the package does, gives the pip install microdf-python line, shows a three-line example (which I ran — median 30000, gini 0.2829), and links to both the examples and the API reference.

docs/examples.md — a dangling reference

Opened with "See these rendered Jupyter notebooks for examples of microdf usage" followed by no links to any notebook. Now links the one notebook that exists. The weight-preservation section below it is untouched.

ROADMAP.md — stale in both directions

  • It listed "Standard error calculations for surveys with replicate weight files" as future work. That shipped in Estimate variance from replicate weights #320 and is the headline feature of the JOSS paper, so a reviewer comparing the paper against the repo would find the repo disowning it.
  • It claimed the package provides "distributional tables, graphs, and special functions for working with PSL Tax-Calculator". None of that is present: grep -ril taxcalc microdf/ returns nothing, and there is no plotting code in the package.

Replaced with what the package actually provides and three things it genuinely does not do yet — design-based variance from stratum and cluster identifiers, dataset presets, and wider pandas shape-change coverage.

No package code changes.

The landing page said function documentation would arrive 'in the
future', which #324 has since added, so the first page of the docs told
a reader the API reference does not exist. It now describes what the
package does, installs it, and links to both pages.

examples.md opened with 'See these rendered Jupyter notebooks' followed
by no links. It now links the one notebook there is.

The roadmap claimed graphs and Tax-Calculator helpers, neither of which
is in the package - grep finds no taxcalc reference and no plotting
code - and listed replicate-weight standard errors as future work, which
shipped in #320 and is the paper's headline feature. Replaced with what
the package does and three things it does not do yet.
@vahid-ahmadi
vahid-ahmadi merged commit 25542d5 into main Sep 18, 2026
8 checks passed
@vahid-ahmadi
vahid-ahmadi deleted the docs/refresh-landing-and-roadmap branch September 18, 2026 14:44
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.

1 participant