interledger / interledger.org-developers Goto Github PK

We are now at 5 Starlight documentation sites, and it is a chore to keep the theme synced up across repositories. As such, we have extracted the shared styles and components into an npm package: https://www.npmjs.com/package/@interledger/docs-design-system. We should update all our docs sites to use this package to keep our theme in sync.

We prototyped the fetching of specification content directly from https://github.com/interledger/rfcs using client-side code, but this is affecting performance. Since this is just static content, we should be able to do it on the server side.

The existing sidebar is a replica of the Jekyll site we migrated for but we need to remove the obsolete ones and include some of the missing ones from the rfcs repository.

The latest version of Starlight (https://github.com/withastro/starlight/releases/tag/%40astrojs%2Fstarlight%400.11.0) released its long-awaited feature for customising Starlight components. Thus far, we have been using a community-sourced "hack" method of doing this (see https://gist.github.com/giuseppelt/7f918a3ac02a011d76811ae472f8bf09), with the intention of migrating to the "official" method of component overriding the moment it was baked. The time has come for this to happen.
We will also need to make some styling tweaks and checks because the API of how the Starlight internals (i.e. CSS classes, HTML structure) would have changed a bit due to the additional feature.

We need to set up a Github action that deploys the built files to our S3 bucket.
https://aws.amazon.com/blogs/security/use-iam-roles-to-connect-github-actions-to-actions-in-aws/

Content for the hackathon resources page needs updating, see https://docs.google.com/document/d/1wL8ZijiaoVUvCVRgH-2XoW5N4S_F3upi-Duo9sxNvSQ/edit

We did not fully resolve the /developers path name issue on some assets and URL redirects. There are also dependency updates that can be bundled together in one maintenance PR.

Content to be pulled through from https://github.com/interledger/rfcs/blob/master/0001-interledger-architecture/0001-interledger-architecture.md

It has been requested that the navigation look the same as the main website, however, Starlight already has a mobile menu, therefore, as a compromise, we will have the consistent navigation on a custom Astro page while everything else which is part of docs uses the Starlight layout, which does not have a top nav bar.

For example, any link on the get started page: https://interledger.org/developers/get-started/
-> Link at the bottom to "Peering, Clearing & Settlement" is https://interledger.org/rfcs/0032-peering-clearing-settlement/, but should instead be https://interledger.org/developers/rfcs/peering-clearing-settling/.

I'm guessing all links suffer from this problem.

Content from https://docs.google.com/document/d/1xZwlmwR7X0-A6P5mJV9rbDcPgx_sI28tzQVDGv68bk8/edit

We need to update the following to match the main website's updated IA and visual direction.

1. Update the splash page's navigation menu
2. Update the hero banner gradient to match the visual direction
3. Update the hero banner font styling to match the visual direction
4. Update the splash page footer