Update or remove docs badges in README

Open Beginner friendly
#7 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
kotlin
Domain
documentation

Research direction

Open README.md and inspect the kdoc and documentation badges and their current targets. Verify which links return 404, then update them with valid documentation links or remove the badges if appropriate. Done means both badges no longer point to invalid links.

Written by the indexing model from the issue text.

Description

README.md contains two badges for docs: kdoc and documentation. Both badges provide invalid links (404) and should be either updated with correct links (probably require adding appropriate docs) or removed.

Dominant language
Kotlin
Stars
0
Forks
1
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from korlibs/korlibs-platform

All issues in korlibs/korlibs-platform

Similar issues

More Kotlin issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.