kossiitkgp / kossiitkgp/docs

Hosting the Docs

Open
#93 0 comments 1 reaction 0 assignees View on GitHub
enhancement good first issue
Dominant language
No language data
Stars
20
Forks
7
PR merge metrics
No merged PRs in 30d

Description

The docs are organised to be easy to migrate to a static-site generator. I believe [Docusaurus](https://docusaurus.io/) was intended, however i would recommend [Hugo](https://gohugo.io/) or [Jekyll](https://jekyllrb.com/)

# Some possible challenges
- adding frontmatter to each page
- try creating a python script to help
- configuring your theme/template
- lotusdocs looks like an interesting hugo theme, see if you find something better

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the current documentation organization and comparing the proposed Docusaurus, Hugo, and Jekyll approaches. Determine how frontmatter and the theme or template would be handled, and whether a Python script is needed to assist. Done means the documentation is migrated to and hosted by a chosen static-site generator.

Written by the indexing model from the issue text.

Assessment

Tech stack
hugo, jekyll, python
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.