H-600, H-618, H-91: Add `hash.dev/docs` section
π What is the purpose of this PR?
Hold fire on merging this until the HASH app is ready for use publicly.
Adds the new hash.dev/docs microsite with information for developers wanting to self-host and use HASH. This PR makes use of the approach from the BP site for generating the docs page sitemap, and implements components based on the existing ones in the BP site (for example the Sidebar and PageNavLinks components).
Remaining TODOs:
- [ ] Add missing content to docs pages
- [ ] Link the use-cases on the docs home page (and elsewhere in the site) to the corresponding docs pages (once they exist)
- [ ] Add appropriate forms where we mention 'filling in email' in the content
π What does this change?
- adds script that generates a
sitemap.jsonfile, which contains a sitemap with the nested docs pages which are made available to components through react context - adds custom
devandbuildscripts which ensure thesitemap.jsonhas been generated - converts the Next.js app to an ESM module
- updates the navbar and mobile navbar to get the site's pages from the sitemap
- adds the
/docshome page, and docs pages based on the implementation of the BP site - Add
InfoCardandInfoCardWrapperMDX components
Pre-Merge Checklist π
π’ Has this modified a publishable library?
This PR:
- [x] does not modify any publishable blocks or libraries, or modifications do not need publishing
π Does this require a change to the docs?
The changes in this PR:
- [x] are internal and do not require a docs change
πΈοΈ Does this require a change to the Turbo Graph?
The changes in this PR:
- [x] do not affect the execution graph
β οΈ Known issues
πΎ Next steps
π‘ What tests cover this?
None
β How to test this?
View the deployment and go visit the /docs page.
πΉ Demo
https://github.com/hashintel/hash/assets/42802102/75f5c283-608e-4920-82dc-cb2ce760e166
@benwerner01 Where a subtitle is provided in MDX topmatter itβs currently showing up in the sidebar as a link. We can remove it from here, as this is unnecessary (we already show the title and this is not a separate section per se, just a provider of additional context about the same thing).
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 27.53%. Comparing base (
fd4d46f) to head (e00ba3c). Report is 1 commits behind head on main.
Additional details and impacted files
@@ Coverage Diff @@
## main #2768 +/- ##
=======================================
Coverage 27.52% 27.53%
=======================================
Files 278 278
Lines 11613 11609 -4
Branches 1177 1174 -3
=======================================
Hits 3196 3196
+ Misses 8401 8397 -4
Partials 16 16
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
β 1 of 2 π