exercism / exercism/nim

Check docs are up to date

Open
#317 2 comments 0 reactions 0 assignees View on GitHub
x:action/improve x:knowledge/none x:size/small x:type/content
Dominant language
Nim
Stars
60
Forks
27
Avg merge
10d 12h
Merged PRs (30d)
1

Description

Please check if your documentation files are still up-to-date.

The key documentation files to check are:

- `docs/ABOUT.md`
- `docs/INSTALLATION.md`
- `docs/LEARNING.md`
- `docs/RESOURCES.md`
- `docs/TESTS.md`
- `exercises/shared/.docs/help.md`
- `exercises/shared/.docs/tests.md`

There might be more.

## Link check report

To help identify invalid links, we've automatically checked the links of _all_ `*.md` files in this repo.
This is the report of that check:

📝 Summary

---------------------
🔍 Total...........62
✅ Successful......62
⏳ Timeouts.........0
🔀 Redirected.......0
👻 Excluded.........0
🚫 Errors...........0


## Tracking

https://github.com/exercism/v3-launch/issues/54

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the listed files, including docs/ABOUT.md, docs/INSTALLATION.md, docs/LEARNING.md, docs/RESOURCES.md, docs/TESTS.md, exercises/shared/.docs/help.md, and exercises/shared/.docs/tests.md. Compare their contents with the current project and inspect the link-check report; done means outdated documentation is identified and updated, with links remaining valid.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.