awslabs / awslabs/palace

Upgrade documentation to MkDocs

Open
#136 1 comment 0 reactions 0 assignees View on GitHub
ci documentation
Dominant language
C++
Stars
562
Forks
121
Avg merge
5d 3h
Merged PRs (30d)
26

Description

The use of Julia's `Documenter.jl` was an early decision that got us up and running quickly, but we aren't tied to it and it doesn't provide any Julia-specific functionality. Using [MkDocs](https://www.mkdocs.org/) provides better visual appeal as well as a larger feature set (increased section depth, better math mode support, for examples).

Contributor guide

Open the contributing guide

Research direction

No files or tests are named. Start by locating the existing Documenter.jl configuration and documentation entry point, then compare the requirements for an MkDocs setup. Done means the documentation builds with MkDocs and replaces the current Documenter.jl setup.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.