Skip to content

any2md 1.0.0rc1 — Phase 4 config + docs release candidate

Pre-release
Pre-release

Choose a tag to compare

@rocklambros rocklambros released this 26 Apr 18:54

Phase 4 of 5: configuration polish and the v1.0 documentation set.

This is the release candidate for 1.0.0. The CLI surface, output contract, and documentation are now feature-complete for v1.0. Phase 5 will run final validation against real-world documents and ship to PyPI as 1.0.0.

What's new in 1.0.0rc1

  • `--profile {conservative,aggressive,maximum}` — tune token-minimization aggressiveness. `maximum` implies `--strip-links`.
  • `--meta KEY=VAL` repeatable flag for frontmatter overrides (dotted keys, comma-separated arrays).
  • `--meta-file PATH` plus auto-discovery of `.any2md.toml` (walks up from cwd).
  • `--auto-id` generates SSRM-conformant `document_id` of the form `{PREFIX}-{YYYY}-{TYPE}-{SHA8}`.
  • `--strict`, `--quiet` / `-q`, `--verbose` / `-v`.
  • New exit codes: 0 success, 1 usage/install error, 2 file failure, 3 strict-mode warning.
  • New module `any2md/config.py` for TOML config discovery and parsing.

Documentation set

  • README rewritten with educational tone (~500 lines)
  • `docs/output-format.md` — SSRM-compatible field reference and content_hash recipe
  • `docs/cli-reference.md` — flag-by-flag with use cases
  • `docs/architecture.md` — pipeline internals and contributor guide
  • `docs/troubleshooting.md` — symptom-cause-fix triage
  • `docs/upgrading-from-0.7.md` — migration guide
  • `CONTRIBUTING.md`
  • GitHub issue templates: generic bug, conversion quality

Install

```bash
pip install --index-url https://pypi.org/simple/ \
--extra-index-url https://test.pypi.org/simple/ \
"any2md==1.0.0rc1"
```

What's next

Phase 5: final QA against real-world test documents (test_docs/COMP4441-FinalProject.docx, ISO_IEC_27002_2022.pdf, https://en.wikipedia.org/wiki/Wikipedia:Signs_of_AI_writing), Docling install verification on clean Mac and Linux, and the 1.0.0 release to PyPI.