README status paragraph links to wrong contract filename

Open Beginner friendly
#768 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
92/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Start in README.md and compare the status paragraph’s contract link with docs/contracts/openstudio-server-v3.11.0-rest.md. Run the supplied Python link-check command; done means every Markdown URL in README.md resolves to an existing file and the command reports no missing paths.

Written by the indexing model from the issue text.

Description

documentation

The README.md status paragraph links to docs/contracts/openstudio-server-v3.11.0.md (no -rest suffix) while the actual file is docs/contracts/openstudio-server-v3.11.0-rest.md. A contributor clicking the link hits a 404.

Acceptance criterion: every URL in README.md resolves to an existing file. Run: python -c "import re,os; [os.path.exists(p.lstrip(chr(39./))) or print(chr(39.MISSING:, p) for p in re.findall(r"\(([^)]+\.md)\)", open(chr(39README.md chr(39)).read()))]" to detect broken links.

Dominant language
Python
Stars
1
Forks
1
Avg merge
18m
Merged PRs (30d)
175

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from anchapin/openstudio-server-operator

All issues in anchapin/openstudio-server-operator

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.