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 #680

Closed
ErikSchierboom opened this issue Aug 20, 2021 · 3 comments · Fixed by #682
Closed

Check docs are up to date #680

ErikSchierboom opened this issue Aug 20, 2021 · 3 comments · Fixed by #682
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..........262
✅ Successful.....261
⏳ Timeouts.........0
🔀 Redirected.......0
👻 Excluded.........0
🚫 Errors...........1

Errors in ./docs/INSTALLATION.md
✗ https://msdn.microsoft.com/en-us/commandline/wsl/about (HTTP status client error (403 Forbidden) for url (https://msdn.microsoft.com/en-us/commandline/wsl/about))

Tracking

exercism/v3-launch#54

@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
wolf99 added a commit that referenced this issue Aug 23, 2021
@wolf99 wolf99 mentioned this issue Aug 23, 2021
@wolf99
Copy link
Contributor

wolf99 commented Aug 23, 2021

Hi @ErikSchierboom ,

What are you using to check links?
We could add this into the CI, or perhaps it could be incorporated into the configlet utility?

ryanplusplus pushed a commit that referenced this issue Aug 23, 2021
@ErikSchierboom
Copy link
Member Author

@wolf99 https://github.com/lycheeverse/lychee I'm thinking of making it a GitHub Action.

@wolf99
Copy link
Contributor

wolf99 commented Oct 13, 2021

@ErikSchierboom Lychee has an action!
https://github.com/marketplace/actions/lychee-broken-link-checker

I am playing around with it on a branch for this repo, see: #706

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