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

Documentation site #1127

Open
dhess opened this issue Mar 27, 2024 · 0 comments
Open

Documentation site #1127

dhess opened this issue Mar 27, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@dhess
Copy link
Member

dhess commented Mar 27, 2024

We need a documentation site:

  1. We will link to it from the app.
  2. We’ll probably want to embed it in the app, preferably via some sort of reusable component.
  3. We’ll probably want to embed Primer programs in the docs site; e.g., for example programs.

In other words, the documentation site will be a full-blown React-based SPA of its own, though preferably most of the content will be statically rendered.

Astro looks interesting for this purpose. It’s framework-agnostic, as far as I’m aware. I believe that Docusaurus uses React under the hood, but my impression is that it’s too static for our needs. VitePress looks nice, but it uses Vue.

@dhess dhess added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 27, 2024
@dhess dhess self-assigned this Mar 27, 2024
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
Projects
None yet
Development

No branches or pull requests

1 participant