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

Create a useful, generated website for publishing Aries RFCs #765

Open
swcurran opened this issue Jan 24, 2023 · 0 comments
Open

Create a useful, generated website for publishing Aries RFCs #765

swcurran opened this issue Jan 24, 2023 · 0 comments

Comments

@swcurran
Copy link
Member

The readmes/markdown files of the Aries RFCs repository are extremely difficult for users of the information to navigate. For those creating RFCs, it’s not too bad, but for those navigating them, it’s a bit of a nightmare.

It would be nice to have a generated site based on requirements for how an end user of the RFCs might want to navigate the site.

  • A landing page for Aries RFCs
  • A central focus (likely right on the landing page) about the currently most active AIP (e.g. right now, AIP 2.0)
    • The AIP version section extracted from RFC 302
    • Links to rendered pages of all of the specific commits of the PRs referenced
      • Not the current version of the document on main.
    • Navigation to jump between the RFCs (e.g. a sidebar has the list of RFCs) within the AIP
    • Ideally — a transformation of the links between the pages to reference this website, not the aries-rfcs repo files.
  • Off the landing page, ways to get to other items of lesser interest:
    • Links to get to the other AIPs, with the same navigation.
    • Links to get to all of the aries-rfcs off of main — perhaps separated by feature and concept
      • Nice to have — the status of the RFC by the link
    • Link to the lifecycle document
    • How to documents — especially contributing to the aries-rfcs

This would likely require a fair bit of code to manipulate the RFC documents to produce the generated website. Code to (for example) extract an AIP list is available in the /code folder, but the transformations to create a navigable site might be tricky.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant