KusionStack/kusion

Feat: auto generate Module reference documentation

Open

#1,010 opened on Apr 10, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Go (108 forks)auto 404
hacktoberfestkind/feature

Repository metrics

Stars
 (1,315 stars)
PR merge metrics
 (PR metrics pending)

Description

This issue does not include a description.

Contributor guide

Research direction
Explore existing Go documentation generation tools like godoc or go swagger, and examine how Kusion modules are currently documented to propose an automated approach.
Tech stack
go
Domain
backenddocumentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Godocumentation generation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70