Skip to content

Commit

Permalink
Make docs links consistent (MetaMask#5920)
Browse files Browse the repository at this point in the history
* Make docs links consistent

So our various docs pages inter-link consistently per MetaMask/metamask-docs#1

* Add docs links to internal docs page
  • Loading branch information
danfinlay authored and whymarrh committed Dec 13, 2018
1 parent 970bdeb commit a6f61d1
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 22 deletions.
25 changes: 4 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,13 @@
# MetaMask Browser Extension
[![Build Status](https://circleci.com/gh/MetaMask/metamask-extension.svg?style=shield&circle-token=a1ddcf3cd38e29267f254c9c59d556d513e3a1fd)](https://circleci.com/gh/MetaMask/metamask-extension) [![Coverage Status](https://coveralls.io/repos/github/MetaMask/metamask-extension/badge.svg?branch=master)](https://coveralls.io/github/MetaMask/metamask-extension?branch=master) [![Stories in Ready](https://badge.waffle.io/MetaMask/metamask-extension.png?label=in%20progress&title=waffle.io)](https://waffle.io/MetaMask/metamask-extension)

## Support
You can find the latest version of MetaMask on [our official website](https://metamask.io/).

For help using MetaMask, visit our [User Support Site](https://metamask.zendesk.com/hc/en-us).

If you're a user seeking support, [here is our support site](https://metamask.zendesk.com/hc/en-us).
For up to the minute news, follow our [Twitter](https://twitter.com/metamask_io) or [Medium](https://medium.com/metamask) pages.

## Introduction
To learn how to develop MetaMask-compatible applications, visit our [Developer Docs](https://metamask.github.io/metamask-docs/).

[Mission Statement](./MISSION.md)

[Documentation](https://metamask.github.io/metamask-docs/)

[Internal Code Documentation](./docs#documentation)

## Developing Compatible Dapps

If you're a web dapp developer, we've got two types of guides for you:

### New Dapp Developers

- We recommend this [Learning Solidity](https://karl.tech/learning-solidity-part-1-deploy-a-contract/) tutorial series by Karl Floersch.
- We wrote a (slightly outdated now) gentle introduction on [Developing Dapps with Truffle and MetaMask](https://medium.com/metamask/developing-ethereum-dapps-with-truffle-and-metamask-aa8ad7e363ba).

### Current Dapp Developers

- If you have a Dapp, and you want to ensure compatibility, [here is our guide on building MetaMask-compatible Dapps](https://github.com/MetaMask/faq/blob/master/DEVELOPERS.md)
To learn how to contribute to the MetaMask project itself, visit our [Internal Docs](https://github.com/MetaMask/metamask-extension/tree/develop/docs).

## Building locally

Expand Down
11 changes: 10 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Documentation

These docs relate to how to contribute to the MetaMask project itself.

You can find the latest version of MetaMask on [our official website](https://metamask.io/).

For help using MetaMask, visit our [User Support Site](https://metamask.zendesk.com/hc/en-us).

For up to the minute news, follow our [Twitter](https://twitter.com/metamask_io) or [Medium](https://medium.com/metamask) pages.

To learn how to develop MetaMask-compatible applications, visit our [Developer Docs](https://metamask.github.io/metamask-docs/).

- [How to add custom build to Chrome](./add-to-chrome.md)
- [How to add custom build to Firefox](./add-to-firefox.md)
Expand All @@ -10,4 +19,4 @@
- [How to add new networks to the Provider Menu](./adding-new-networks.md)
- [How to manage notices that appear when the app starts up](./notices.md)
- [How to port MetaMask to a new platform](./porting_to_new_environment.md)
- [How to generate a visualization of this repository's development](./development-visualization.md)
- [How to generate a visualization of this repository's development](./development-visualization.md)

0 comments on commit a6f61d1

Please sign in to comment.