website icon indicating copy to clipboard operation
website copied to clipboard

New spec page structure-

Open kwennB opened this issue 1 year ago • 2 comments

What kind of change does this PR introduce?

Documentation Enhancement Spec-structure-json

Issue Number:

Screenshots/videos:

Added

Summary

The Specification section of the docs is fixed to adapt to the proposed change in alignment with Diataxsis and issue #791

  • It fixes the spec navigation
  • Draft templates
  • Re-edits Release note page
  • Re-edits JSON hyper-schema page
  • Adds a Migration page

Does this PR introduce a breaking change?

No

kwennB avatar Jul 25 '24 09:07 kwennB

Thank you for your review, @valeriahhdez. They've been addressed.

kwennB avatar Aug 05 '24 11:08 kwennB

Hi @benjagm The commits you added to the Migration page introduced these errors. Could you take a look? thank you.

image

kwennB avatar Aug 19 '24 11:08 kwennB

Hi @benjagm The commits you added to the Migration page introduced these errors. Could you take a look? thank you.

I pushed some changes to fix this and other issues. Please check it and let me know.

benjagm avatar Aug 26 '24 09:08 benjagm

Hi @benjagm The commits you added to the Migration page introduced these errors. Could you take a look? thank you.

I pushed some changes to fix this and other issues. Please check it and let me know.

Thank you for the code. It works now.

kwennB avatar Aug 26 '24 10:08 kwennB

Hi Blessing. This looks great, my only 2 comments:

  • JSON Hyper Schema: Are we going to merge this and update the page afterwards after finishing the work with Jason? We need to check this with him.
  • Redirections:I don't see changes in the public/_redirects file. Remember we need to add here all the redirections avoid 404 errors afters changing the URLs ... for example in the release notes.

Thank you Benja.

Yes let's merge and update afterwards. I will work on the redirections now

kwennB avatar Sep 13 '24 06:09 kwennB