bitovi / bitovi/bitops

Plugin docs aggregation

Open
#260 0 comments 0 reactions 0 assignees View on GitHub
documentation 📗
Dominant language
Python
Stars
37
Forks
9
PR merge metrics
No merged PRs in 30d

Description

**Why are you updating / adding this documentation?**
We should have a way to aggregate the docs for plugins in github.com/bitops-plugins.

Each plugin would host a `docs/` directory of markdown files.
The bitops repo's docs build process would then clone each plugin repo, extract the docs, and include them in the build for the main docs page.

Contributor guide

Open the contributing guide

Research direction

Start by inspecting the existing docs build process and the plugin repositories in github.com/bitops-plugins, including their docs/ directories. Determine how plugin repositories would be cloned and their Markdown files extracted. Done means the aggregated plugin documentation is included in the main docs build and appears on the main documentation page.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github, markdown
Domain
build-system, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.