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

ADR - Website language and framework #8

Closed
widal001 opened this issue Dec 26, 2024 · 0 comments · Fixed by #15
Closed

ADR - Website language and framework #8

widal001 opened this issue Dec 26, 2024 · 0 comments · Fixed by #15
Assignees
Labels
adr An architectural decision to record area: website Issues related to the website

Comments

@widal001
Copy link
Collaborator

Decision

Choose a language and a framework for the static site for the protocol.

Decision drivers

  • Site is simple to build, maintain, and host
  • Site can be easily extended with custom components or styling
  • Site's language is used elsewhere in the project
  • Site's language and framework is popular and familiar to most developers

Options

  • Starlight/Astro (TypeScript)
  • Next.js (TypeScript)
  • Hugo (Golang)
  • Mkdocs (Python)
@widal001 widal001 added the adr An architectural decision to record label Dec 26, 2024
@widal001 widal001 self-assigned this Dec 26, 2024
@widal001 widal001 changed the title Website language and framework ADR - Website language and framework Dec 26, 2024
widal001 added a commit that referenced this issue Dec 31, 2024
* docs: Center side-by-side table in ADR template
* docs: Adds ADR for using Starlight as our docs framework
* docs: Adds ADR for hosting website on GitHub pages
* docs: Updates website/README
* docs: Update root-level README
* build: Updates `npm run preview` to build and host
@widal001 widal001 added this to the RFC0001 planning milestone Jan 1, 2025
@widal001 widal001 added the area: website Issues related to the website label Jan 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
adr An architectural decision to record area: website Issues related to the website
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant