cake-contrib / cake-contrib/Home

Use Wyam for documentation

Open
#18 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
13
Forks
8
PR merge metrics
No merged PRs in 30d

Description

Don't know if this is possible, but IMHO it would be nice to use Wyam for documentation and publish it to the root of https://cake-contrib.github.io.

In this case we could also maintain some kind of JSON file with information about the addins and generate content of the status.md, addins.md and modules.md file dynamically.

With this https://cake-contrib.github.io could serve as a nice site for browsing the different addins part of this organization.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing status.md, addins.md, and modules.md files and the current cake-contrib.github.io site. Investigate how Wyam could generate documentation from a JSON file containing add-in information. Done means the documentation is generated and published at the site root with browsable add-in content.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, markdown
Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.