Skip to content

Conversation

bradlarsen
Copy link
Contributor

@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
@bradlarsen
Copy link
Contributor Author

I'm still sorting out a hosting solution for these docs.

In the meantime, here are offline-generated docs for the current snapshot: site.tgz

@munntjlx
Copy link
Contributor

Nice to see the docs they look beautimous!

@Coruscant11
Copy link
Contributor

Nice one! Thanks for your work

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.

3 participants