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

Open
ErikSchierboom opened this issue Aug 20, 2021 · 4 comments
Open

Check docs are up to date #495

ErikSchierboom opened this issue Aug 20, 2021 · 4 comments
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...........31
✅ Successful......29
⏳ Timeouts.........0
🔀 Redirected.......0
👻 Excluded.........0
🚫 Errors...........2

Errors in ./bin/README.md
✗ http://showterm.io/54d5cf196eb45a0e40640 (HTTP status server error (500 Internal Server Error) for url (http://showterm.io/54d5cf196eb45a0e40640))
✗ http://showterm.io/cc7ddb7b23bb73e784d7d (HTTP status server error (500 Internal Server Error) for url (http://showterm.io/cc7ddb7b23bb73e784d7d))

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
@kotp
Copy link
Member

kotp commented May 5, 2023

@m-dango I merged the #611 PR I think that addresses this?

@m-dango
Copy link
Member

m-dango commented May 5, 2023

I think it addresses the issue partially but there may be more to check.

@rcmlz
Copy link
Contributor

rcmlz commented Mar 8, 2024

I did some proposals for updating the docs here: updating docs #695.

@kotp
Copy link
Member

kotp commented Mar 8, 2024

@rcmlz I updated the link to go straight to the pull request for easier referencing and tracking.

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

No branches or pull requests

4 participants