Review analysis/overview.md after new pages were created on developer.yoast.com
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 52/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start with docs/features/analysis/overview.md, then review the documentation added in issues 226, 227, and 228. Remove or replace redundant information and add links to the three new overview pages; the work is done when the overview is current and no longer duplicates those pages.
Written by the indexing model from the issue text.
Description
Please give us a description of the issue
- I've read and understood the contribution guidelines.
- I've searched for any related issues and avoided creating a duplicate issue.
This task was created as part of this task: https://github.com/Yoast/non-dev-tasks/issues/39
See report in first comment to this task for context.
This task is blocked by:
- https://github.com/Yoast/developer/issues/226
- https://github.com/Yoast/developer/issues/227
- https://github.com/Yoast/developer/issues/228
In these three tasks, documentation was added to developer.yoast.com. As a result analysis/overview.md might have information that is redundant now, or could better live in the newly created pages.
- Review analysis/overview.md to assess which information could be removed or replaced.
- Add links to the overview pages created in https://github.com/Yoast/developer/issues/226, https://github.com/Yoast/developer/issues/227 and https://github.com/Yoast/developer/issues/228
- Dominant language
- JavaScript
- Stars
- 15
- Forks
- 23
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Yoast/developer
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Typos Open
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 55/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Similar issues
-
bot:ai-assisted component:compact-js status:untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
midnightntwrk/midnight-sdk#403 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 86/100
DavidAnson/markdownlint-cli2#940 ·
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
githubnext/gh-aw-workshop#3692 ·
-
agent/guide documentation hive/hosted-available-lke648397-260827-5n31
Difficulty 2/5 1-3 hours Newbie friendliness 90/100