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

feat: Link directly to doc semantic framework #37

Merged
merged 1 commit into from
Apr 29, 2024

Conversation

cpb8010
Copy link
Contributor

@cpb8010 cpb8010 commented Apr 29, 2024

This was unclear if not already familiar with the framework and avoids conflating this with eastern orthodoxy liturgy

What 💻

  • Replace the text Diataxis with a link to the diataxis page in the header section
  • Replace the text Diataxis with a link to the diataxis page in the category section

Why ✋

  • I hadn't heard of this framework before
    *Searching for this text brings up some conflicting results depending on what site you trust

Evidence 📷

From here: https://zksync-docs-staging-5eb09--pr37-cbe-devrl-527-link-t-lxa3l56t.web.app/build/contributing-to-documentation/documentation-styleguide

image

This was unclear if not already familiar with the framework and
avoids conflating this with eastern orthodoxy liturgy
Copy link

Visit the preview URL for this PR (updated for commit a294467):

https://zksync-docs-staging-5eb09--pr37-cbe-devrl-527-link-t-lxa3l56t.web.app

(expires Mon, 06 May 2024 15:19:54 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: bfaafba5fa82d4f63473aaa76a21fabf1fbb3a11

@cpb8010 cpb8010 marked this pull request as ready for review April 29, 2024 15:24
@cpb8010 cpb8010 requested a review from a team as a code owner April 29, 2024 15:24
@cpb8010 cpb8010 self-assigned this Apr 29, 2024
@cpb8010 cpb8010 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 29, 2024
Copy link
Contributor

@bxpana bxpana left a comment

Choose a reason for hiding this comment

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

LGTM

@cpb8010 cpb8010 merged commit 70a91e2 into staging Apr 29, 2024
7 checks passed
@cpb8010 cpb8010 deleted the cbe-devrl-527-link-to-diataxis branch April 29, 2024 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants