Skip to content

docs: correct verified README and contribution instructions - #17

Open
SakarPaisen wants to merge 1 commit into
ClaviOpen:mainfrom
SakarPaisen:docs/issue-16-verifiable-documentation-fixes
Open

SakarPaisen wants to merge 1 commit into
ClaviOpen:mainfrom
SakarPaisen:docs/issue-16-verifiable-documentation-fixes

Conversation

@SakarPaisen

Copy link
Copy Markdown

Closes #16

What

Objective, verifiable documentation corrections in README.md and CONTRIBUTING.md only. No code, manifest, dependency, asset, or behaviour change.

README.md

  • Fix the HTML attribute typo <p aligh="center"> -> <p align="center"> in the screenshot block.
  • Fix the broken Markdown ordered list in the Firefox build steps (5.Select -> 5. Select); without the space the line is not parsed as a list item.
  • In the Firefox load steps, replace the Chrome wording ("Open Clavimit from Chrome and use the side panel") with the Firefox equivalent ("Open Clavimit from Firefox and use the sidebar").
  • Fix the broken license link [LICENSE](LICENSE) -> [LICENSE](LICENSE.md) (the repository contains LICENSE.md, no plain LICENSE).

CONTRIBUTING.md

  • In "Build for Firefox", fix "The generated Chrome extension is written to: dist/firefox" -> "The generated Firefox extension is written to: dist/firefox".
  • Same Firefox sidebar wording fix as above in the Firefox load steps.
  • In "Reporting issues -> Bug reports", make the environment instructions usable for both supported browsers: add the Firefox equivalents of Load unpacked (Load Temporary Add-on), of the published store listing (Firefox Add-ons) and of the version page (about:addons).
  • Fix the broken license link [LICENSE](LICENSE) -> [LICENSE](LICENSE.md).

Why these specific changes (evidence)

  • build/build.js writes the build to dist/<browser>, so npm run build:firefox produces dist/firefox. Both builds were run successfully and produced dist/chrome and dist/firefox.
  • src/manifest/firefox.json declares sidebar_action.default_panel and src/scripts/browser/firefox.js calls chrome.sidebarAction.open(), while src/manifest/chrome.json declares sidePanel / side_panel.default_path and src/scripts/browser/chrome.js calls chrome.sidePanel.open(). So the Chrome text keeps "side panel" and the Firefox text says "sidebar".
  • git ls-files shows LICENSE.md and no LICENSE, so the previous license links 404'd.
  • README publishes the extension on both the Chrome Web Store and Firefox Add-ons (both URLs resolve), so the bug-report environment instructions cover both browsers.

Validation

Command Result
git diff --check exit 0
npm ci exit 0
npm run format:check exit 0 - "All matched files use Prettier code style!"
npm test exit 0 - 2 files, 32 tests passed
npm run build:chrome exit 0 - dist/chrome
npm run build:firefox exit 0 - dist/firefox

Markdown is excluded from Prettier via .prettierignore, so these doc edits cannot affect format:check. A baseline run with the edits stashed produced identical results, so no failure was introduced and there is no known baseline failure.

This change and PR description were prepared with AI assistance.

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.

Improve README.md and CONTRIBUTING.md files

1 participant