Ammalgam-Protocol / docs

Public documentation for the Ammalgam Protocol
https://docs-chi-self.vercel.app
1 stars 1 forks source link

Added contract docs to docusaurus docs #12

Closed duelinggalois closed 10 months ago

duelinggalois commented 10 months ago

Figured out a way to combine docs rather than having do doc instances. Ideally this could be automated in the future, but for now, it is a manual process that isn't too painful. I describe the process in the README.md. There are some additional fixes in the docs that need to be made so that certain md files render correctly.

vercel[bot] commented 10 months ago

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

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 8, 2023 9:09pm
duelinggalois commented 10 months ago

I couldn't figure out how to filter the contracts out of showing in the primary docs. Some of the suggestions to modify the sidebar when using auto-generated in Docusaurus docs where causing a recusive loop or something and breaking the build. Open to suggestions as I also didn't want to add another folder.

I can work on capitalizing, I think I want to move the script to core-v1 as its running with dependencies from that repo and then create a release pipeline to open a pr in docusaurus.

Sent from Proton Mail mobile

-------- Original Message -------- On Nov 10, 2023, 7:15 AM, Eswara Sai wrote:

@eswarasai commented on this pull request.

I think these look great overall except for couple of minor things below:

  • Why the need for docs/primary subpath? Not sure if we want the primary subpath at all. I liked the previous URLs better
  • Sidebar has the folders in smaller case, wouldn't it be preferable to have the capitalized? docs-sidebar

— Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you authored the thread.Message ID: @.***>

duelinggalois commented 10 months ago

Closing in favor of #25