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

feat: Link directly to doc semantic framework #37

Merged
merged 1 commit into from
Apr 29, 2024
Merged

feat: Link directly to doc semantic framework #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/00.build/90.contributing-to-documentation/30.documentation-styleguide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ To minimize confusion due to global date format variations, adhere to the follow

## Kinds of zkSync Documentation

Following the Diataxis framework, zkSync Docs categorizes content into:
Following the [Diataxis](https://diataxis.fr/) framework, zkSync Docs categorizes content into:

- **Tutorials**: Step-by-step instructions to teach general skills (e.g., Deploying your first contract on zkSync Era).
- **Guides**: Task completion instructions for readers with basic knowledge (e.g., Debugging with zksync-cli).
Expand All @@ -46,7 +46,7 @@ Following the Diataxis framework, zkSync Docs categorizes content into:

### Choosing a category for writing

Leverage the Diataxis system when crafting a new article for zkSync Docs.
Leverage the [Diataxis](https://diataxis.fr/) system when crafting a new article for zkSync Docs.
Writing without a clear category often results in unfocused content.
A well-defined focus keeps the content streamlined and clarifies the takeaway for the reader.

Expand Down
Loading