-
Notifications
You must be signed in to change notification settings - Fork 126
Links
Use short descriptive link text that helps provide context for the material that you're linking to.
Tip: Do not use "here" as link text.
Follow these examples that use descriptive link text and link to external URLs:
```markdown
a test framework [Jest](https://jestjs.io/)
```
```markdown
code auto-formatting [Prettier](https://prettier.io/
```
```markdown
linting [ES Lint](https://eslint.org/)
```
Markdown links work in different ways on our docs site. Although you can use a relative path, the preferred syntax is to use the file path after the base docs site URL, which simplifies maintenance.
You can link to specific headings on the same or different page and link to other doc pages.
-
If your doc is not yet published, you can still form links. See How to see your local doc updates during development for steps to build the docs locally so you can test the doc build and see local updates before you push changes to GitHub.
-
Local doc builds resolve to http://localhost:3000/.
For example, a local doc build URL for a specific heading on a page is http://localhost:3000/zkapps/how-zkapps-work#prover-function-and-verification-key.
- To form the link syntax, copy the link URL after http://localhost:3000/.
-
Select the heading on the docs page to display the direct link in the web browser address bar.
-
Copy the link after https://docs.minaprotocol.com/.
These examples use the shortened internal URL for linking to other doc pages:
See [how zkApps work](/zkapps/how-zkapps-work), [how to write a zkApp](/zkapps/how-to-write-a-zkapp), and [zkApps for Ethereum Developers](/zkapps/zkapps-for-ethereum-developers)See [Install Mina zkApp CLI](/zkapps/how-to-write-a-zkapp#install-mina-zkapp-cli)Linking to GitHub directories and files:
For links from files in the /docs2 repo to files in the /docs2 repo, you can use the shortened file path after the base docs site URL:
- Use tree for directories:
[examples/zkapps/06-offchain-storage/contracts](https://github.com/o1-labs/docs2/tree/main/examples/zkapps/06-offchain-storage/offchain-storage-zkapp/contracts)- Use blob for files:
[src/main.ts](https://github.com/o1-labs/docs2/blob/main/examples/zkapps/06-offchain-storage/offchain-storage-zkapp/contracts/src/main.ts)Follow these best practices for sharing links to Mina Protocol Discord.
Consistency builds trust. Follow these guidelines each time you share a Discord link in the docs, Tweets, and other content.
The official invite link for the Mina Protocol Discord is tracked with https://bit.ly/MinaDiscord.
It's okay to use:
[Mina Protocol Discord](https://discord.gg/minaprotocol)For Mina Foundation tracking, use:
[Mina Protocol Discord](https://bit.ly/MinaDiscord)Both of these invite URLs resolve to https://discord.com/invite/minaprotocol.
To copy a link to a specific channel in the Discord app and in Discord.com/app web browser UI:
- Right-click a channel and select Copy Link.
Using consistent channel URLs has several nifty benefits:
- Provides a consistent user experience
- Masks the identity that is otherwise revealed when we "invite people" to a channel
- Generates a non-expiring link
Use only the channel name as the link text.
Participate in the [#zkapps-developers](https://discord.com/channels/484437221055922177/915745847692636181) channel on Mina Protocol Discord.[#announcements](https://discord.com/channels/484437221055922177/601171209287368715)
[#delegation-program](https://discord.com/channels/484437221055922177/808895957978447882)
[#grants](https://discord.com/channels/484437221055922177/727960609832042607)
[#ledger-hardware](https://discord.com/channels/484437221055922177/733755408161833040)
[#mentor-nodes](https://discord.com/channels/484437221055922177/746316198806814760)
[#mainnet-block-producers](https://discord.com/channels/484437221055922177/799597981762453535)
[#security](https://discord.com/channels/484437221055922177/799979001585336331)
[#zkapps-developers](https://discord.com/channels/484437221055922177/915745847692636181)
[#zkapps-general](https://discord.com/channels/484437221055922177/910549624413102100)
[#zkapps-questions](https://discord.com/channels/484437221055922177/1047214314349658172)README files are an exception to using a shortened file path after the base docs site URL.
Because README files populate the npm package, you must use full, absolute links so that the links work on npm.
For example, the o1js README uses absolute links so that the links on the o1js npm package resolve correctly.