add files
This commit is contained in:
@@ -0,0 +1,26 @@
|
||||
{
|
||||
"project": "PDFtoMD",
|
||||
"phase": "8-release-docs-packaging",
|
||||
"steps": [
|
||||
{
|
||||
"step": 0,
|
||||
"name": "readme-usage-flow",
|
||||
"status": "pending"
|
||||
},
|
||||
{
|
||||
"step": 1,
|
||||
"name": "environment-bootstrap-docs",
|
||||
"status": "pending"
|
||||
},
|
||||
{
|
||||
"step": 2,
|
||||
"name": "license-checkpoint",
|
||||
"status": "pending"
|
||||
},
|
||||
{
|
||||
"step": 3,
|
||||
"name": "release-checklist",
|
||||
"status": "pending"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
# Step 0: readme-usage-flow
|
||||
|
||||
## Read First
|
||||
- /AGENTS.md
|
||||
- /PLAN.md
|
||||
- /PROGRESS.md
|
||||
- /docs/HARNESS.md
|
||||
- /docs/IMPLEMENTATION_PLAN.md
|
||||
- /README.md
|
||||
- /phases/7-mvp-quality-hardening/index.json
|
||||
|
||||
## Task
|
||||
Update README usage flow for the MVP CLI.
|
||||
|
||||
Document install, validation, basic conversion, formula parser modes, runtime modes, output layout, resume, and logs.
|
||||
|
||||
## Sprint Contract
|
||||
- Done means: a user can follow README instructions to run the local CLI on Windows after environment setup.
|
||||
- Hard thresholds: commands match implemented CLI; docs do not promise PyQt or hosted API as MVP; generated output contract is accurate.
|
||||
- Files owned: `README.md`, docs as needed, `PROGRESS.md`, `phases/8-release-docs-packaging/index.json`.
|
||||
- Dependencies: MVP quality hardening complete.
|
||||
|
||||
## Acceptance Criteria
|
||||
```powershell
|
||||
python scripts\validate_workspace.py
|
||||
```
|
||||
|
||||
## Verification
|
||||
1. Run the acceptance command.
|
||||
2. Confirm documented commands are copy-pasteable in PowerShell.
|
||||
3. Update `PROGRESS.md` and this phase index.
|
||||
|
||||
## Do Not
|
||||
- Do not document unimplemented features as available.
|
||||
- Do not add marketing-style content.
|
||||
- Do not include model weights in the repository.
|
||||
@@ -0,0 +1,38 @@
|
||||
# Step 1: environment-bootstrap-docs
|
||||
|
||||
## Read First
|
||||
- /AGENTS.md
|
||||
- /PLAN.md
|
||||
- /PROGRESS.md
|
||||
- /docs/HARNESS.md
|
||||
- /docs/IMPLEMENTATION_PLAN.md
|
||||
- /docs/TOOLCHAIN.md
|
||||
- /requirements.txt
|
||||
|
||||
## Task
|
||||
Document and optionally script the repo-local environment bootstrap flow.
|
||||
|
||||
Cover Conda Python 3.11, requirements install, CUDA smoke test, `pip check`, and Nougat help check.
|
||||
|
||||
## Sprint Contract
|
||||
- Done means: environment setup instructions reflect the verified GTX 1070 Ti / torch 2.7.1+cu126 baseline.
|
||||
- Hard thresholds: dependency pins remain consistent across README, TOOLCHAIN, and requirements; no unverified torch upgrade is introduced.
|
||||
- Files owned: `README.md`, `docs/TOOLCHAIN.md`, optional `scripts/`, `PROGRESS.md`, phase index.
|
||||
- Dependencies: MVP CLI docs.
|
||||
|
||||
## Acceptance Criteria
|
||||
```powershell
|
||||
python scripts\validate_workspace.py
|
||||
.\venv\python.exe -m pip check
|
||||
.\venv\Scripts\nougat.exe --help
|
||||
```
|
||||
|
||||
## Verification
|
||||
1. Run the acceptance commands where local environment is available.
|
||||
2. Explain any skipped environment command in `PROGRESS.md`.
|
||||
3. Update this phase index.
|
||||
|
||||
## Do Not
|
||||
- Do not replace the single `venv` policy.
|
||||
- Do not require `uv`.
|
||||
- Do not change pins without official compatibility verification.
|
||||
@@ -0,0 +1,36 @@
|
||||
# Step 2: license-checkpoint
|
||||
|
||||
## Read First
|
||||
- /AGENTS.md
|
||||
- /PLAN.md
|
||||
- /PROGRESS.md
|
||||
- /docs/HARNESS.md
|
||||
- /docs/IMPLEMENTATION_PLAN.md
|
||||
- /docs/ADR.md
|
||||
- /docs/TOOLCHAIN.md
|
||||
|
||||
## Task
|
||||
Add a licensing checkpoint document or section for current personal use and future redistribution/commercial review.
|
||||
|
||||
This is not legal advice. It should identify Marker GPL/model-weight concerns and when to revisit them.
|
||||
|
||||
## Sprint Contract
|
||||
- Done means: docs clearly state current personal-use context and future review triggers.
|
||||
- Hard thresholds: docs do not claim legal conclusions; process/API isolation is described only as a risk mitigation candidate; model weights are not redistributed.
|
||||
- Files owned: `docs/TOOLCHAIN.md`, `docs/ADR.md`, optional `README.md`, `PROGRESS.md`, phase index.
|
||||
- Dependencies: Release docs context.
|
||||
|
||||
## Acceptance Criteria
|
||||
```powershell
|
||||
python scripts\validate_workspace.py
|
||||
```
|
||||
|
||||
## Verification
|
||||
1. Run the acceptance command.
|
||||
2. Confirm license notes are cautious and consistent.
|
||||
3. Update `PROGRESS.md` and this phase index.
|
||||
|
||||
## Do Not
|
||||
- Do not provide legal advice.
|
||||
- Do not mark the project commercially safe without review.
|
||||
- Do not vendor model weights.
|
||||
@@ -0,0 +1,36 @@
|
||||
# Step 3: release-checklist
|
||||
|
||||
## Read First
|
||||
- /AGENTS.md
|
||||
- /PLAN.md
|
||||
- /PROGRESS.md
|
||||
- /docs/HARNESS.md
|
||||
- /docs/IMPLEMENTATION_PLAN.md
|
||||
- /README.md
|
||||
- /docs/TOOLCHAIN.md
|
||||
|
||||
## Task
|
||||
Create the local MVP release checklist.
|
||||
|
||||
Include validation, sample smoke conversion, environment checks, offline cache readiness, known limitations, and next phase entry conditions.
|
||||
|
||||
## Sprint Contract
|
||||
- Done means: the repository has a concise checklist for deciding whether the local MVP is ready for personal use.
|
||||
- Hard thresholds: checklist references real commands; known limitations are explicit; PyQt phase remains separate.
|
||||
- Files owned: `README.md`, optional `docs/RELEASE_CHECKLIST.md`, `PROGRESS.md`, phase index.
|
||||
- Dependencies: Prior release docs steps.
|
||||
|
||||
## Acceptance Criteria
|
||||
```powershell
|
||||
python scripts\validate_workspace.py
|
||||
```
|
||||
|
||||
## Verification
|
||||
1. Run the acceptance command.
|
||||
2. Confirm checklist can be followed by a fresh agent or user.
|
||||
3. Update `PROGRESS.md` and this phase index.
|
||||
|
||||
## Do Not
|
||||
- Do not claim production readiness.
|
||||
- Do not include hosted API release work.
|
||||
- Do not start PyQt implementation.
|
||||
Reference in New Issue
Block a user