cmars / cmars/greenroom

Merge godocs into existing techdocs

Open
#2 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
3
Forks
2
PR merge metrics
No merged PRs in 30d

Description

If a project already has an existing `mkdocs.yml` with techdocs, godocs should go into a sub-nav item, perhaps named "Go Packages" by default.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the existing mkdocs.yml handling and the godocs-to-TechDocs generation path. Verify how an existing techdocs navigation is represented, then confirm that Go Packages is added as a sub-navigation item without replacing the existing navigation; a project without existing techdocs should continue to work.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.