Closed general

Run pages: no way to target a sub-readme folder of an existing page (one page per project)

John Lauer · ·closed by John Lauer

Seen with adom-aiflow 0.2.15.

start --page, intake --page, report --page and clips --page take a page (owner/slug), but not a folder inside it. The run README always goes to docs/runs/<id>/ at the page's root, and the clips page to docs/clips.md. project-page creates a new page.

That fights the "one page per project" rule. Here, every board of a project lives in a sub-readme folder of the project's page: the encoder's test rig boards are under rig/boards/<board>/ on one private page. For a board run there, the choice today is between:

  • writing into the root docs/ of a page another thread is editing;
  • minting a new page per board;
  • running with no page and copying the run's README, clips and step evidence into the board's folder by hand. This is what I am doing.

Asked for:

  • a folder option on start, intake, report, clips and project-page, for example --page owner/slug --page-dir rig/boards/rig-carrier, so every push lands under that folder and the URLs it writes (render paths, PCM repository URLs, files/... links) include it;
  • project-page --page owner/slug --page-dir <folder>, so it writes the board's README and its PCM repository into that folder of an existing page and never creates one.

2 Replies

John Lauer ·

Related: report without --page refuses ("no page for this run"), and 0.2.15 has no local-only mode. So a run that must not push anywhere has no run README at all. I wrote three by hand from run.jsonl, under rig/boards/<board>/ on john/capacitive-encoder. Asked for: report with no page writes the run README locally, for example to <run>/report/README.md, and pushes nothing.

John Lauer ·

Fixed in adom-aiflow 0.2.16, including the local-only report from your reply.

--page-dir <folder> on start, intake, report and clips, saved in the run:

  • The folder must be relative, with no leading slash, no .. and no backslash. . sets it back to the page root.
  • The run README goes to <folder>/docs/runs/<id>/, the clips page to <folder>/docs/clips.md, and clip media to <folder>/docs/clips/.
  • Every link the run writes carries the folder: the files links, the render paths and the clip media paths.
  • A new --page without --page-dir drops the old folder. clips --page-dir alone moves only the clips page.

project-page --page owner/slug --page-dir <folder> writes into a folder of an existing page and never creates one:

  • It implies --existing and refuses a missing page and --create.
  • The README goes to <folder>/README.md, only if the folder has none yet (or with --replace-readme).
  • The PCM repository goes to <folder>/pcm/, with every repository, packages and download URL carrying the folder.
  • The library nickname, PCM identifier and Cloud Library name include the folder, so two boards on one page don't share a library.
  • --sync writes the step pages to <folder>/steps/.

report with no page writes <run>/report/README.md, with its media beside it and linked relatively, and pushes nothing. The OK line says so.

One related fix: clip videos used to be linked to the project page even when they were pushed to the clips or run page. They now point to the page they actually went to.

A test with a stand-in adom-wiki checks that every push lands only under the folder and that no linked file is missing. Not yet run against the real wiki: your next board run under rig/boards/<board>/ is the acceptance test.

Upgrade: adom-wiki pkg install adom/adom-aiflow, then adom-aiflow --version says 0.2.16.

John Lauer closed this ·

Log in to reply.