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

NextJS Docs Rewrite #184

Open
ZeroIntensity opened this issue Jun 14, 2024 · 0 comments
Open

NextJS Docs Rewrite #184

ZeroIntensity opened this issue Jun 14, 2024 · 0 comments
Assignees
Labels
complex This should only be looked at by someone who knows what they're doing docs Documentation change feature New feature hot This is high priority
Milestone

Comments

@ZeroIntensity
Copy link
Owner

Proposal:

I think it's time to say farewell to MkDocs and mkdocs-material. view.py recently tried writing its own theme for MkDocs, but the result wasn't what I wanted, and so I rolled the docs over to mkdocs-material instead.

The plan now is to use NextJS and MDX for documentation. The most challenging part of this migration (apart from actually writing the docs) is going to be dealing with mkdocstrings generation. I somehow need to figure out how to transfer the generated markdown from mkdocstrings to the TypeScript code. If all fails, view.py will have to abandon mkdocstrings, and write the API reference from scratch (which won't be pretty.)

This will also switch the build system from Netlify to Vercel, but that should be fine.

@ZeroIntensity ZeroIntensity added docs Documentation change hot This is high priority feature New feature complex This should only be looked at by someone who knows what they're doing labels Jun 14, 2024
@ZeroIntensity ZeroIntensity self-assigned this Jun 14, 2024
@ZeroIntensity ZeroIntensity added this to the Beta Release milestone Jun 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complex This should only be looked at by someone who knows what they're doing docs Documentation change feature New feature hot This is high priority
Projects
None yet
Development

No branches or pull requests

1 participant