Docs/copy edit 1 - Githubissues

0xPolygonMiden / compiler

Compiler from MidenIR to Miden Assembly

MIT License

63 stars 21 forks source link

Docs/copy edit 1 #315

Closed kmurphypolygon closed 3 weeks ago

kmurphypolygon commented 3 weeks ago

This PR does a quick scan and update for style guide.
Please note only one # (H1) per page.
Also added back the requirements.txt and run script for easy spin up of docs.
Fixed a link.

kmurphypolygon commented 3 weeks ago

Just a quick note please @bitwalker .. we have an error on main docs

The following pages exist in the docs directory, but are not included in the "nav" configuration:
             - miden/miden-compiler/appendix/known-limitations.md

This file will remain live and searchable even if there is no menu link to it ... so I'm not sure it that's what you need? Or perhaps you need to add a menu link?

bitwalker commented 3 weeks ago

@kmurphypolygon I've added the missing nav item for that page, build instructions for the docs, and the tweaks I suggested, in the latest commit. I'm going to go ahead and merge this, but if you spot any other issues or have other suggested changes, let me know!