psychoinformatics-de/shacl-vue

Add automated API docs

Open

#27 opened on Jun 19, 2024

View on GitHubContributor guide
 (5 comments) (0 reactions) (0 assignees)Vue (4 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Contributor guide

Research direction
Evaluate the listed JSDoc themes (clean jsdoc theme, better docs, docdash) for integration with the existing JSDoc example in the repository. Determine how to generate automated API documentation from JSDoc comments and configure the chosen theme.
Tech stack
javascript
Domain
documentation
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JSDocJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65