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

Docs: improved mermaid diagram for better visibility. Add "MaheshG11" as contributor #5874

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

MaheshG11
Copy link

@MaheshG11 MaheshG11 commented Nov 14, 2024

Proposed Commit Message

docs: Adjust arrow color in Mermaid diagrams for improved visibility; Add "MaheshG11" as Contributor

Changed the color of arrows in Mermaid diagrams to enhance visibility
in both dark and light mode themes. This change ensures that the diagrams
are readable regardless of the viewing mode.

Fixes issue #5837 

Fixes issue #5837

Additional Context

  1. Modified the lineColor property of arrows for all mermaid diagrams in the documentation to a neutral color that stands out in both dark and light modes.
  2. Added "MaheshG11" to tools/.github-cla-signers.
  3. IMPORTANT: Changed the order in conf.py file, this was done because it was giving import errors on running build commands.

Test Steps

Only for Linux/Unix Operating systems

  1. In the main repo cd doc/rtd
  2. Run sphinx-build -b html . build/html
  3. Run xdg-open build/html/index.html. This should open up browser with the local build.
  4. In browser you will be on /index.html. Navigate to /explanation/boot.html. Here you will find changes that were made by this commit.

Merge type

… as Contributor

docs: improved mermaid diagram. Add "MaheshG11" as contributor

docs: improved mermaid diagram. Add "MaheshG11" as Contributor
@github-actions github-actions bot added the documentation This Pull Request changes documentation label Nov 14, 2024
@MaheshG11 MaheshG11 closed this Nov 14, 2024
@MaheshG11 MaheshG11 reopened this Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This Pull Request changes documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant