feat: Tool to check validity of files found in details section
- Dominant language
- Go
- Stars
- 30
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
If I specify a finish markdown file (instead of using the finish directive) maybe check that file exists, otherwise in my markdown metadata, I can promise you that a file is there which won't be there, which will result in a rendered broken guide. I shouldn't be able to lie about the existence of files.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by locating the Go code that parses markdown metadata and handles the finish directive or finish file. Trace how referenced files are resolved, then add validation so a missing finish file is reported before rendering; done means invalid metadata cannot produce a guide with a broken finish-file reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100