JanssenProject / JanssenProject/jans

docs: Use Kiro to review docs and suggest improvements

Open
#11,951 0 comments 0 reactions 0 assignees View on GitHub
area-documentation comp-docs
Dominant language
Java
Stars
648
Forks
174
Avg merge
1d 18h
Merged PRs (30d)
110

Description

**Description:**
We should run the **Kiro** documentation analysis tool against the Janssen project docs to:

1. **Identify broken references**

* Detect invalid or outdated links (internal & external)
* Catch incorrect cross-references between sections or pages
* Highlight missing or incorrectly formatted anchors

2. **Find missing or incomplete content**

* Spot TODO markers, placeholder text, and stub sections
* Flag API references without descriptions or examples
* Detect inconsistencies between code samples and documentation

3. **Improve overall documentation quality**

* Ensure consistency in headings, formatting, and style
* Surface opportunities to reorganize or clarify content
* Reduce friction for developers and contributors

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Janssen project documentation and determining how Kiro can analyze it; no specific files, tests, or entry points are named. Done should include a completed analysis covering broken references, missing or incomplete content, and documentation quality improvements, with actionable findings or suggested changes.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.