dss-extensions / dss-extensions/OpenDSSDirect.jl

Use mkdocs instead of default documentation

Open
#47 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Julia
Stars
30
Forks
6
PR merge metrics
No merged PRs in 30d

Description

`mkdocs` supports more extensions and themes (See https://squidfunk.github.io/mkdocs-material/) and imho looks nicer. However, The default documentation allows looking at multiple versions using a drop down. With `mkdocs` we'll need to either add a separate markdown file with links to older versions or write some additional html / css / js to make that work. Any thoughts?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the repository's current default documentation setup and the MkDocs Material reference linked in the issue. Decide how older-version navigation should work—links or custom HTML/CSS/JS; done means an agreed migration path that preserves access to older versions.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
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.