adobe / adobe/ops-cli

Add gh-pages based docs

Open
#76 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Python
Stars
203
Forks
39
PR merge metrics
No merged PRs in 30d

Description

README.md grew large so it would be useful to structure the docs in a gh-pages based site.
We can use: [jekyll](https://jekyllrb.com/), [mkdocs](https://www.mkdocs.org/) or [hugo](https://gohugo.io/documentation/) as doc site generator

Contributor guide

Open the contributing guide

Research direction

Start with README.md, then compare the proposed Jekyll, MkDocs, and Hugo options for structuring the existing documentation as a gh-pages-based site. Done means the documentation has a selected site generator, is organized beyond the single README, and is available through gh-pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
hugo, jekyll
Domain
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.