Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CIP-0030 | Fix API headers for markdown portability #601

Merged

Conversation

rphair
Copy link
Collaborator

@rphair rphair commented Oct 4, 2023

Recognised in #591 (comment) (cc @SmaugPool) and cleaned up here since running this code through Showdown in site builders causes text inside angle brackets beginning \< to be dropped unless quoted literally in Markdown (as code would be).

To avoid too many unnecessary changes, I've only applied this change to the API section and not the preceding error types or data types. Perhaps for functional & aesthetic considerations other reviewers might think these literals should also be quoted as code. 🤔 cc @rooooooooob

  • NOTE data type cbor<T> suffers the same problem I've also quoted it as code.
  • @Ryun1 @Crypto2099 @SebastienGllmt please look at the code segment in that section where I've also removed the quote back-slashes, which also truncate the code in Showdown and don't look right to me as code in the first place (?). If the back-slashes are necessary in the code, maybe we can find a portable way of putting them back in. 😵‍💫

What we're mainly trying to achieve is the correct appearance of this page on the Dev Portal (cc @katomm), which currently has sections of code in many of the API section headers truncated (cc @KtorZ): https://developers.cardano.org/docs/governance/cardano-improvement-proposals/CIP-0030


(how it renders with the changes in this branch)

@Ryun1
Copy link
Collaborator

Ryun1 commented Oct 4, 2023

I'm happy to remove the \s, I did this for my endpoints in CIP-95 already -- to me it just looks a little cleaner overall. We can make this the "standard" for web-bridges if we want.

This change also does not seem to affect existing links to sections which is super nice.

Copy link
Contributor

@rooooooooob rooooooooob left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. It would be nice if we could make them bigger while being code, but judging from CIP-95 it looks good still. And consistent with other CIP(s?) that had this issue. The API is pretty unhelpful as-is on the cardano site so you need to reference the github code, but when searching it's the cardano site that pops up and not the github one so this should help a lot.

Copy link
Collaborator

@Crypto2099 Crypto2099 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes look good to me and make sense as a standard we can attempt/encourage to follow going forward for other CIPs requiring code examples.

@rphair rphair merged commit 446d7d5 into cardano-foundation:master Oct 17, 2023
Scitz0 added a commit to Scitz0/CIPs that referenced this pull request Oct 17, 2023
Scitz0 added a commit to Scitz0/CIPs that referenced this pull request Oct 17, 2023
rphair added a commit that referenced this pull request May 14, 2024
* CIP-???? | CIP-30 ext: Account public key

A [CIP-30 extension](https://cips.cardano.org/cips/cip30/#cardanowalletnameenableextensionsextensionpromiseapi) that allows for a DApp (if allowed) to fetch the connected account public key. Utilizes yet to-be-merged CIP-30 namespace PR #577.

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <[email protected]>

* standard form for copyright footer

Co-authored-by: Ryan Williams <[email protected]>

* Update according to #590

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <[email protected]>

* change delimiter character as per #594

* title delimiter changed to - as per #594 update

* assign CIP number 104

* Updates according to assigned CIP number

* updates according #601

* Move access line to spec section

---------

Co-authored-by: Robert Phair <[email protected]>
Co-authored-by: Ryan Williams <[email protected]>
rphair added a commit that referenced this pull request May 28, 2024
* CIP-???? | CIP-30 ext: Bulk transaction signing

Replaces previous PR #443 by adopting CIP-30 extension framework as well as to-be-merged CIP-30 namespace PR #577.

* update api call to use cip namespace

* add checkboxes for items we're not sure are done yet

* word accuracy + grammar

* Mark criteria as completed

* include *all* prior GitHub discussion (2 PRs)

Co-authored-by: Ryan Williams <[email protected]>

* Update according to #590

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <[email protected]>

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <[email protected]>

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <[email protected]>

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <[email protected]>

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <[email protected]>

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <[email protected]>

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <[email protected]>

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <[email protected]>

* Addresses mentioned comments

* change delimiter character as per #594

* title delimiter changed to - as per #594 update

* assign CIP number 103

* Updates according to assigned CIP number

* Updates according to #601

* Update CIP-0103/README.md

Co-authored-by: Ryan <[email protected]>

* Update CIP-0103/README.md

Co-authored-by: Ryan <[email protected]>

* Update CIP-0103/README.md

Co-authored-by: Ryan <[email protected]>

---------

Co-authored-by: Robert Phair <[email protected]>
Co-authored-by: Ryan Williams <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants