nakamoto updates - Githubissues

hirosystems / docs

Hiro developer documentation website

https://docs.hiro.so/

Apache License 2.0

35 stars 56 forks source link

nakamoto updates #636

Closed ryanwaits closed 6 months ago

ryanwaits commented 6 months ago

What does this PR do?

[x] add a banner and call to action that points to new nakamoto updates page
[x] update .md extensions to .mdx in stacks.js module to avoid build issues
[x] create a new nakamoto updates page with a changelog for all products
[x] add a sidebar item for this new page
[x] add a new api reference to nakamoto.10 at /nakamoto-api

vercel[bot] commented 6 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
hiro-systems-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 25, 2024 9:18pm

ryanwaits commented 6 months ago

observing an issue with our layout pages that should render banners post docusaurus 3 version upgrade, and having trouble figuring out what the breaking change was and why they aren't showing up. for now ill commit the version back to 2.4.3 since this shouldn't break any existing updates since then

ryanwaits commented 6 months ago

in addition, ran into some odd build issues with some formatting in the stacks.js markdown files, so i reformatted a few lines and changed the extensions to use .mdx instead of .md which seems to have solved the issue.

...in case anyone is wondering why the diff is larger than expected.

diwakergupta commented 6 months ago

observing an issue with our layout pages that should render banners post docusaurus 3 version upgrade, and having trouble figuring out what the breaking change was and why they aren't showing up. for now ill commit the version back to 2.4.3 since this shouldn't break any existing updates since then

hmm, feels like a pretty big hammer (reverting back to docusaurus 2) for this one nail. can you do just the changelog and sidebar for now, I'm happy to dig into the banner issue separately. that way you needn't block on downgrading the whole thing.

ryanwaits commented 6 months ago

can you do just the changelog and sidebar for now

yeah that's fine with me if we're cool without the banner

i also had one other option i wanted to try with v3 to see if that would fix the banner - mainly just wanted to have a working version up if all else failed, that way you dont need to waste any time going down that rabbit hole

ryanwaits commented 6 months ago

my guess is the linkcheck is failing because of a reference to the new /nakamoto-api path so should fix itself when merged

ryanwaits commented 6 months ago

These are formatting improvements -- otherwise looks great!

thanks @smcclellan !