OpenRefine / OpenRefine/openrefine.org

Remove outdated code references from extension documentation

Open
#522 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
TypeScript
Stars
161
Forks
142
Avg merge
6h 10m
Merged PRs (30d)
9

Description

The documentation on writing extensions references a few outdated parts of the codebase. One example is the menu bar section, which references a JS file that no longer exists.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start with docs/technical-reference/writing-extensions.md, especially the main menu section, and inspect the current codebase to identify which referenced parts are outdated. Update the extension documentation so its code references point to existing parts of the project, and confirm that no obsolete references remain.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.