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.

Sign up for GitHub

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

Jump to bottom

Add a cross-chain guide for the documentation #3325

Merged
merged 11 commits into from
May 4, 2022
Merged

Add a cross-chain guide for the documentation #3325

merged 11 commits into from
May 4, 2022

Conversation

Amxx
Copy link
Collaborator

@Amxx Amxx commented Apr 7, 2022

Add a cross-chain guide for the documentation

frangio
frangio reviewed May 3, 2022
View reviewed changes
docs/modules/ROOT/pages/crosschain.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/crosschain.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/crosschain.adoc Show resolved Hide resolved
docs/modules/ROOT/pages/crosschain.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/crosschain.adoc Show resolved Hide resolved
docs/modules/ROOT/pages/crosschain.adoc Show resolved Hide resolved
docs/modules/ROOT/pages/crosschain.adoc Outdated Show resolved Hide resolved
frangio
frangio approved these changes May 4, 2022
View reviewed changes
Copy link
Contributor

@frangio frangio left a comment

Choose a reason for hiding this comment

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

I made some edits in the last commits. Looks good to merge.

The tests are not running for some reason.

@Amxx Amxx enabled auto-merge (squash) May 4, 2022 21:09
@Amxx Amxx merged commit 4574ce4 into OpenZeppelin:master May 4, 2022
@Amxx Amxx deleted the docs/crosschain branch May 4, 2022 21:20
Amxx added a commit that referenced this pull request May 4, 2022
@Amxx
Add a cross-chain guide for the documentation (#3325)
7be85b7 
(cherry picked from commit 4574ce4)
Signed-off-by: Hadrien Croubois <hadrien.croubois@gmail.com>
@htadashi
Copy link
Contributor

htadashi commented Jun 1, 2022

@Amxx @frangio
Thanks for the incredible work! I am not sure if this bug is related to solidity-docgen or the docs builder from this repo (and that is why I am commenting here instead of opening an issue), but usage of the unicode '⇌' seems to break the docs. For each ⇌ introduced, more characters from outside the comments are included:

image
(From https://docs.openzeppelin.com/contracts/4.x/api/crosschain#CrossChainEnabledAMB)

@Amxx
Copy link
Collaborator Author

Amxx commented Jun 1, 2022

Nice find @htadashi.

Can you open an issue about that?

@htadashi
Copy link
Contributor

htadashi commented Jun 1, 2022

Should I open in openzeppelin-contracts or in solidity-docgen? I couldn't isolate where the bug is.

@frangio
Copy link
Contributor

frangio commented Jun 1, 2022

Thanks @htadashi I think this is a problem in solidity-docgen. Please open an issue there!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@frangio frangio frangio approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Amxx @htadashi @frangio