Skip to content

Replace the boilerplate README with a pointer to the docs - #20

Open
peterbjohnson wants to merge 1 commit into
mainfrom
readme_redirect
Open

Replace the boilerplate README with a pointer to the docs#20
peterbjohnson wants to merge 1 commit into
mainfrom
readme_redirect

Conversation

@peterbjohnson

Copy link
Copy Markdown
Member

Closes #15

Problem

README.md was the unmodified template from evaluation-function-boilerplate-python, 238 lines that never mentioned music, MIDI or audio. Several parts were not merely generic but wrong:

  • The release badge still contained the literal {REPO_NAME_HERE} placeholder, so the button linked to a repository that does not exist.
  • The development workflow described editing evaluation_function.wl, a Wolfram file that does not exist here.
  • The repository structure omitted compare_MIDI.py and audio_processing.py, the two files that hold all of the logic.
  • The deployment section pointed at .github/workflows/deploy.yml; this repo has staging-deploy.yml and production-deploy.yml.
  • It documented a dev.py invocation that fails immediately (Leftover boilerplate: dev.py, preview.py, healthcheck and return annotation are all broken #14).
  • The Quickstart chapter was the template's own setup guide, which the template itself says to delete once setup is done.

Change

Following the convention used by compareExpressions: a short description plus a pointer to the documentation, which already exists and is good.

  • Title and three sentences on what the function does.
  • Working release-request badge.
  • Links to docs/user.md and docs/dev.md. Those are the files the platform fetches into the central docs site via EvalDocsLoader, so they are the canonical location.
  • An accurate six-line repository structure, since the previous one hid the two files that matter.
  • Install, test, and container commands, including the request shape the container actually answers.

238 lines to 49.

A note on the local request shape

The README states that the container answers POST / with a command: eval header. This differs from the central documentation, which gives an AWS Lambda emulator path. That page is wrong for a plain docker run, and I have raised it separately as lambda-feedback/user-documentation#38. The shape documented here is the one verified against this image.

No published docs link

compareExpressions links to its page on the documentation site. The equivalent URL for this function currently returns 404, presumably because it is not registered yet, so I have linked only the in-repo files rather than adding a dead link. Worth adding once it is deployed.

On testing

There is no test in this PR. The change is prose, and its correctness is a human judgement rather than something to assert.

I did check mechanically that every relative link resolves, that each path named in the structure block exists, and that no template placeholders remain. One thing here is a real contract worth guarding: docs/user.md and docs/dev.md are fetched by the platform, so renaming either silently breaks the central docs site. That belongs with the other deployment-contract checks rather than in a file of its own, so I would rather fold it into the environment tests once #17 and #18 land than add a third test file now.

Check Result
Full suite 73 passed
Relative links resolve 2 of 2
Structure paths exist 9 of 9
Template placeholders 0

🤖 Generated with Claude Code

The README was the unmodified template from
evaluation-function-boilerplate-python. It never mentioned music, MIDI or
audio, and several parts were actively wrong:

- the release badge still contained the literal {REPO_NAME_HERE}
  placeholder, so the button linked to a repository that does not exist
- the development workflow described editing evaluation_function.wl, a
  Wolfram file that does not exist here
- the repository structure omitted compare_MIDI.py and audio_processing.py,
  the two files holding all the logic
- the deployment section pointed at .github/workflows/deploy.yml, while
  this repo has staging-deploy.yml and production-deploy.yml
- it documented a dev.py invocation that fails immediately (see #14)
- the Quickstart chapter was the template's own setup guide, which the
  template says to delete once setup is done

Replace it with a short description and links to docs/user.md and
docs/dev.md, which is where the real documentation already lives, and
which the platform publishes to the central docs site.

238 lines to 49.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.

README is still the unmodified boilerplate template

2 participants