Skip to content

Conversation

schlessera
Copy link

There are two syntax issues with the first mermaid diagram - a mix-up between == and -- syntax within a single directional relation.

image

I assume this worked before but now broke because the validation in the mermaid parser became stricter.

Given that I don't know what purpose the differentiation between --> and ==> was supposed to signify (and it does not come with any legend to this regard), I opted to just strip all ==> (bold) relations and consistently use --> throughout the diagram.

Summary

Replaces all the different types of arrows with a consistent --> (single-dash) syntax.

Relevant technical choices

Technical choices that affect more than this issue:

Test instructions

This PR can be acceptance tested by following these steps:

  1. First diagram should render correctly at https://developer.yoast.com/features/indexables/technical-specification/

Quality assurance

  • Security - I have thought about any security implications this code might add.
  • Performance - I have checked that this code doesn't impact performance (greatly).
  • Caching - I have analyzed the caching methods that this code touches and have added instructions to deal with those.
  • Tested - I have tested this code to the best of my abilities.
  • Automated tests - I have added unit tests to verify the code works as intended.
  • Testability - I have added unique ids to elements, so they can be located in automated testing.
  • I have altered a filename.
    • I have adjusted the ID property accordingly and updated all internal links.
    • I have added the redirect to the _redirects file in the root of the project.

There are two syntax issues with the first mermaid diagram - a mix-up between `==` and `--` syntax within a single directional relation.

I assume this work before but now broke because the validation in the mermaid parser became stricter.

Given that I don't know what purpose the differentiation between `-->` and `==>` was supposed to signify (and it does not come with any legend to this regard), I opted to just strip all `==>` (bold) relations and consistently use `-->` throughout the diagram.
Copy link

Deploying yoast-developer with  Cloudflare Pages  Cloudflare Pages

Latest commit: 94196ed
Status: ✅  Deploy successful!
Preview URL: https://317607af.yoast-developer.pages.dev
Branch Preview URL: https://fix-broken-indexables-diagra.yoast-developer.pages.dev

View logs

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.

1 participant