bitcobblers / bitcobblers/ZeUnit

dotnet xml docs output included in the documentation.

Open
#64 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
C#
Stars
5
Forks
2
PR merge metrics
No merged PRs in 30d

Description

The core documentation is written in MDX files in the route docs folder, but documentation for the code it self and the explicit interfaces can also be useful especially if we talking about linking to specifics in documentation.

Need to create a SSG page that will convert those XML./YML files into static html wrapped inside the document page.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inspecting the MDX files in the route docs folder and the XML/YML documentation inputs to understand the existing documentation build. Determine where static pages are generated and how they are wrapped in the document layout. Done means the code and explicit-interface documentation is available as static HTML pages and can be linked from the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
build-system, documentation
Issue type
Feature
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.