Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Overhaul docs with new MkDocs-based site #245

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Overhaul docs with new MkDocs-based site #245

wants to merge 4 commits into from

Conversation

bradlarsen
Copy link
Collaborator

@bradlarsen bradlarsen commented Jan 14, 2025

This overhauls the documentation for Nosey Parker, creating a new Material for MkDocs-based site.

The pages look like this at the moment.

Landing page:
image

Installation instructions:
image

Data model reference:
image

New listing of built-in rules:
image

Integrated full-text search:
image

@bradlarsen bradlarsen added documentation Improvements or additions to documentation enhancement New feature or request ux Related to the user experience, invocation, or CLI labels Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request ux Related to the user experience, invocation, or CLI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant