Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check docs are up to date #436

Closed
6 tasks done
ErikSchierboom opened this issue Aug 20, 2021 · 2 comments · Fixed by #439
Closed
6 tasks done

Check docs are up to date #436

ErikSchierboom opened this issue Aug 20, 2021 · 2 comments · Fixed by #439
Assignees
Labels
x:action/improve Improve existing functionality/content x:knowledge/none No existing Exercism knowledge required x:size/small Small amount of work x:type/content Work on content (e.g. exercises, concepts)

Comments

@ErikSchierboom
Copy link
Member

ErikSchierboom commented Aug 20, 2021

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..........170
✅ Successful.....168
⏳ Timeouts.........0
🔀 Redirected.......0
👻 Excluded.........0
🚫 Errors...........2

Errors in ./docs/RESOURCES.md
✗ http://www-cgi.cs.cmu.edu/afs/cs.cmu.edu/user/dst/www/LispBook/index.html (HTTP status client error (404 Not Found) for url (http://www-cgi.cs.cmu.edu/afs/cs.cmu.edu/user/dst/www/LispBook/index.html))

Errors in ./README.md
✗ https://github.com/exercism/common-lisp-representer. (404 Not Found: Not Found)

Tracking

exercism/v3-launch#54

  • Review listed docs above for correctness
  • fix dead link to LispBook
  • fix broken representer link
  • change exercism.io & exercism.lol links to be internal links
  • correct internal links in: concepts/functions/about.md
  • correct internal links in: reference/implementating-a-concept-exercise
@ErikSchierboom ErikSchierboom added x:size/small Small amount of work x:type/content Work on content (e.g. exercises, concepts) x:knowledge/none No existing Exercism knowledge required x:action/improve Improve existing functionality/content labels Aug 20, 2021
@verdammelt verdammelt added the v3 label Aug 21, 2021
@verdammelt
Copy link
Member

@ErikSchierboom Lychee looks pretty useful - can you share what command line options you used for this?

@verdammelt
Copy link
Member

I used lychee and set a base url of https://exercism.lol and found the following errors:

📝 Summary
---------------------
🔍 Total..........180
✅ Successful.....172
⏳ Timeouts.........0
🔀 Redirected.......0
👻 Excluded.........0
🚫 Errors...........8

Errors in concepts/functions/about.md
✗ https://exercism.lol/rest-parameters/about.md (HTTP status client error (404 Not Found) for url (https://exercism.lol/rest-parameters/about.md))
✗ https://exercism.lol/default-parameters/about.md (HTTP status client error (404 Not Found) for url (https://exercism.lol/default-parameters/about.md))
✗ https://exercism.lol/named-parameters/about.md (HTTP status client error (404 Not Found) for url (https://exercism.lol/named-parameters/about.md))
✗ https://exercism.lol/recursion/about.md (HTTP status client error (404 Not Found) for url (https://exercism.lol/recursion/about.md))
✗ https://exercism.lol/scope/about.md (HTTP status client error (404 Not Found) for url (https://exercism.lol/scope/about.md))

Errors in reference/implementing-a-concept-exercise.md
✗ https://exercism.lol/bin/generate-scaffolding/README.md (HTTP status client error (404 Not Found) for url (https://exercism.lol/bin/generate-scaffolding/README.md))
✗ https://exercism.lol/exercises/concept/socks-and-sexprs (HTTP status client error (404 Not Found) for url (https://exercism.lol/exercises/concept/socks-and-sexprs))
✗ https://exercism.lol/exercises/concept/README.md (HTTP status client error (404 Not Found) for url (https://exercism.lol/exercises/concept/README.md))

Looks like links to concepts etc. are not set up correctly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
x:action/improve Improve existing functionality/content x:knowledge/none No existing Exercism knowledge required x:size/small Small amount of work x:type/content Work on content (e.g. exercises, concepts)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants