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

docs: inline mermaid diagrams while aquamarine is fixed #13302

Merged
merged 1 commit into from
Dec 12, 2024
Merged

docs: inline mermaid diagrams while aquamarine is fixed #13302

merged 1 commit into from
Dec 12, 2024

Conversation

vcastellm
Copy link
Contributor

Re-exports doesn't work well with include_mmd! so we're embedding the diagrams in the code meanwhile.

Fixes #4430

mattsse
mattsse requested changes Dec 11, 2024
View reviewed changes
Copy link
Collaborator

@mattsse mattsse left a comment

Choose a reason for hiding this comment

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

this seems fine, in case we need to update the mermaid file, the additional effort is negligible,

would like to keep the include_mmd macro as comments though

crates/transaction-pool/src/pool/txpool.rs Show resolved Hide resolved
@mattsse mattsse added the C-docs An addition or correction to our documentation label Dec 11, 2024
@vcastellm vcastellm requested a review from mattsse December 12, 2024 09:45
@mattsse
Copy link
Collaborator

mattsse commented Dec 12, 2024

pending clippy

@vcastellm vcastellm force-pushed the vcastellm/mermaid-embed branch from 9c994f2 to b19da03 Compare December 12, 2024 11:35
@vcastellm
docs: inline mermaid diagrams meanwhile aquamarine is fixed
b7da3a3 
Re-exports doesn't work well with include_mmd! so we're embedding the diagrams in the code meanwhile.

- Add TODO comments for inlined diagrams
@vcastellm vcastellm force-pushed the vcastellm/mermaid-embed branch from b19da03 to b7da3a3 Compare December 12, 2024 11:40
@vcastellm vcastellm changed the title docs: inline mermaid diagrams meanwhile aquamarine is fixed docs: inline mermaid diagrams while aquamarine is fixed Dec 12, 2024
@vcastellm
Copy link
Contributor Author

Fixed clippy and squashed 😅 thx @mattsse

@mattsse mattsse added this pull request to the merge queue Dec 12, 2024
github-merge-queue bot pushed a commit that referenced this pull request Dec 12, 2024
@vcastellm
docs: inline mermaid diagrams while aquamarine is fixed (#13302)
009a4b0
Merged via the queue into paradigmxyz:main with commit dbc8766 Dec 12, 2024
42 checks passed
@vcastellm vcastellm deleted the vcastellm/mermaid-embed branch December 12, 2024 14:02
emhane pushed a commit to ethereum-optimism/op-reth that referenced this pull request Dec 13, 2024
@vcastellm @emhane
docs: inline mermaid diagrams while aquamarine is fixed (paradigmxyz#…
f538268 
…13302)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mattsse mattsse mattsse approved these changes

@emhane emhane Awaiting requested review from emhane

@Rjected Rjected Awaiting requested review from Rjected Rjected is a code owner

Assignees
No one assigned
Labels
C-docs An addition or correction to our documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Mermaid diagrams are not rendered in reth crate docs
2 participants
@vcastellm @mattsse