ardalis / ardalis/ApiEndpoints

Docs: Set up a Docs Site for ApiEndpoints using GitHub Pages

Open
#173 0 comments 0 reactions 0 assignees View on GitHub
enhancement good first issue hacktoberfest help wanted
Dominant language
C#
Stars
3.2k
Forks
232
PR merge metrics
No merged PRs in 30d

Description

Model this on the Ardalis.Specification approach:

- https://github.com/ardalis/Specification/tree/main/docs
- https://ardalis.github.io/Specification/
- https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site

Contributor guide

Open the contributing guide

Research direction

Review the linked Ardalis.Specification docs directory and rendered site, then compare their structure with the ApiEndpoints repository. Read the GitHub Pages setup guidance to determine the required documentation and publishing configuration. Done means ApiEndpoints has a documented site structure and a working GitHub Pages deployment comparable to the reference.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.