Documentation: check for invalid references in CI

Uses https://github.com/serokell/xrefcheck to check for invalid
references on CI. Also, fix all the present invalid references to make
sure the new job passes.

Author: balsoft

.xrefcheck.yaml

@@ -0,0 +1,60 @@
+# Parameters of repository traversal.
+traversal:
+  # Files and folders which we pretend do not exist
+  # (so they are neither analyzed nor can be referenced).
+  ignored:
+    # Git files
+    - .git
+    # Build artifacts
+    - _build
+    - _opam
+    # Git submodules
+    - src/external
+    - src/lib/marlin
+    - src/lib/snarky
+    - frontend/wallet/tablecloth
+
+# Verification parameters.
+verification:
+  # On 'anchor not found' error, how much similar anchors should be displayed as
+  # hint. Number should be between 0 and 1, larger value means stricter filter.
+  anchorSimilarityThreshold: 0.5
+
+  # When checking external references, how long to wait on request before
+  # declaring "Response timeout".
+  externalRefCheckTimeout: 10s
+
+  # Prefixes of files, references in which should not be analyzed.
+  notScanned:
+    - .github/pull_request_template.md
+    - .github/issue_template.md
+    - .github/PULL_REQUEST_TEMPLATE
+    - .github/ISSUE_TEMPLATE
+
+  # Glob patterns describing the files which do not physically exist in the
+  # repository but should be treated as existing nevertheless.
+  virtualFiles:
+    - ../../../issues
+    - ../../../issues/*
+    - ../../../pulls
+    - ../../../pulls/*
+
+  # POSIX extended regular expressions that match external references
+  # that have to be ignored (not verified).
+  # It is an optional parameter, so it can be omitted.
+  ignoreRefs:
+    - "https://github.com/.*" # Otherwise Resource unavailable (429 too many requests)
+
+  # Check localhost links.
+  checkLocalhost: false
+
+  # Skip links which return 403 or 401 code.
+  ignoreAuthFailures: true
+
+# Parameters of scanners for various file types.
+scanners:
+  markdown:
+    # Flavor of markdown, e.g. GitHub-flavor.
+    #
+    # This affects which anchors are generated for headers.
+    flavor: GitHub

CODE_OF_CONDUCT.md

@@ -54,7 +54,7 @@ If a community member engages in unacceptable behavior, the community organizers
 
 ## 6. Reporting Guidelines
 
-If you are subject to or witness unacceptable behavior, or have any other concerns, please notify the Mina community as soon as possible by emailing [email protected]. Please see the [Reporting Guidelines](/docs/reporting-guidelines.md). You can also contact an admin in the [Discord server](https://bit.ly/MinaDiscord).
+If you are subject to or witness unacceptable behavior, or have any other concerns, please notify the Mina community as soon as possible by emailing [email protected]. You can also contact an admin in the [Discord server](https://bit.ly/MinaDiscord).
 
 Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress.
 
@@ -68,6 +68,6 @@ This Code of Conduct and its related procedures also applies to unacceptable beh
 
 ## 8. License and attribution
 
-This Code of Conduct is adapted from the [Stumptown Syndicate](http://stumptownsyndicate.org) Code of Conduct under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/).
+This Code of Conduct is adapted from the [Stumptown Syndicate](https://github.com/stumpsyn) Code of Conduct under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/).
 
 Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy).

CONTRIBUTING.md

@@ -10,9 +10,9 @@ basic setup you need to get up and running to build and edit Coda.
 Here's the summary if you want to contribute code:
 
 1. Learn some OCaml. The [Real World OCaml](https://dev.realworldocaml.org/toc.html) book is good. Jane Street also has [some exercises](https://github.com/janestreet/learn-ocaml-workshop).
-2. Learn how we use OCaml. We have [a style guide](https://github.com/CodaProtocol/coda/blob/master/docs/style_guide.md) that goes over the important things.
+2. Learn how we use OCaml. We have [a style guide](https://docs.minaprotocol.com/en/developers/style-guide) that goes over the important things.
 3. Fork and clone the repo, then set up your development environment. See the [developer README](README-dev.md) for details.
-4. Find a good first issue. The best issues to start with are those tagged [`category-mentored`](https://github.com/CodaProtocol/coda/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Acategory-mentored). These have a detailed description on how to approach the issue and someone appointed to help people solve it. Once you're famliar with the codebase, [`category-quick-fix`](https://github.com/CodaProtocol/coda/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc++label%3Acategory-quick-fix+) is a good source of reasonably well-defined tasks.
+4. Find a good first issue. The best issues to start with are those tagged [`easy`](https://github.com/MinaProtocol/mina/labels/easy).
 5. Create a branch in your local clone and implement the solution.
 6. Push the branch to your GitHub fork and create a pull request.
 7. 🙌
@@ -21,7 +21,8 @@ Here's the summary if you want to contribute code:
 
 Bug reports should include, at minimal, the `coda -version` output and
 a description of the error. See the [bug report
-template](.github/ISSUE_TEMPLATES/bug_report.md).
+template](.github/ISSUE_TEMPLATE/1-BUG_REPORT.yml). Documentation
+issues and failing tests should be reported using respective templates.
 
 All bugs need to be reproduced before they can be fixed. Anyone can try and
 reproduce a bug! If you have trouble reproducing a bug, please comment with what
@@ -35,8 +36,7 @@ Maintainers should label bug reports with `bug`, and any other relevant labels.
 
 We'll consider any feature requests, although the most successful feature
 requests usually aren't immediately posted to the issue tracker. The most
-successful feature requests start with discussion in the community! See the
-[feature request template](.github/ISSUE_TEMPLATES/feature_request.md).
+successful feature requests start with discussion in the community!
 
 Maintainers should label feature requests with `feature`, and any other relevant
 labels.
@@ -47,9 +47,10 @@ All pull requests go through CircleCI, which makes sure the code doesn't need to
 be reformatted, builds Coda in its various configurations, and runs all the
 tests.
 
-All pull requests must get _code reviewed_. Anyone can do a code review! Check
-out the [code review guide](docs/code_review.md) for what to look for. Just leave
-comments on the "Files changed" view.
+All pull requests must get _code reviewed_. Anyone can do a code
+review! Check out the [code review
+guide](https://docs.minaprotocol.com/en/developers/code-reviews) for
+what to look for. Just leave comments on the "Files changed" view.
 
 All pull requests must be approved by at least one member of the "core eng"
 team on github.
@@ -77,12 +78,13 @@ Changes to the software should come with changes to the documentation.
 
 ## RFCs
 
-The `rfcs` directory contains files documenting major changes to the software,
-how we work together, or the protocol. To make an RFC, just copy the
-`0000-template.md` to `0000-shortname.md` and fill it out! Then, open a pull
-request where the title starts with `[RFC]`. The idea is that we can discuss the
-RFC and come to consensus on what to do. Not all RFCs are merged, only the ones
-that we agree to implement.
+The [`rfcs`](rfcs/) directory contains files documenting major changes
+to the software, how we work together, or the protocol. To make an
+RFC, just copy the `0000-template.md` to `0000-shortname.md` and fill
+it out! Then, open a pull request where the title starts with
+`[RFC]`. The idea is that we can discuss the RFC and come to consensus
+on what to do. Not all RFCs are merged, only the ones that we agree to
+implement.
 
 This process isn't final, but in general:
 

README-dev.md

@@ -2,8 +2,7 @@
 
 Mina is a new cryptocurrency protocol with a lightweight, constant-sized blockchain.
 
-- [Developer homepage](https://codaprotocol.com/code.html)
-- [Roadmap](https://codaprotocol.com/docs/developers)
+- [Developer homepage](https://docs.minaprotocol.com/en/developers)
 - [Repository Readme](README.md)
 
 If you haven't seen it yet, [CONTRIBUTING.md](CONTRIBUTING.md) has information
@@ -38,7 +37,7 @@ Refer to [/dev](/dev).
   - If this is your first time using OCaml, be sure to run `eval $(opam config env)`
 - Invoke `rustup toolchain install 1.52.1`
 - Invoke `make build`
-- Jump to [customizing your editor for autocomplete](#dev-env)
+- Jump to [customizing your editor for autocomplete](#customizing-your-dev-environment-for-autocompletemerlin)
 
 ### Developer Setup (Linux)
 
@@ -50,9 +49,8 @@ Refer to [/dev](/dev).
 
 Mina has a variety of opam and system dependencies.
 
-You can see [`Dockerfile-toolchain`](/dockerfiles/Dockerfile-toolchain) for how we
-install them all in the container. To get all the opam dependencies
-you need, you run `opam switch import src/opam.export`.
+To get all the opam dependencies you need, you run `opam switch import
+src/opam.export`.
 
 Some of our dependencies aren't taken from `opam`, and aren't integrated
 with `dune`, so you need to add them manually, by running `scripts/pin-external-packages.sh`.
@@ -68,6 +66,7 @@ ocaml-rocksdb.
 - [Ubuntu Setup Instructions](https://docs.docker.com/install/linux/docker-ce/ubuntu/)
 
 #### Customizing your dev environment for autocomplete/merlin
+[dev-env]: #dev-env
 
 - If you use vim, add this snippet in your vimrc to use merlin. (REMEMBER to change the HOME directory to match yours)
 
@@ -113,9 +112,6 @@ It also knows how to use Docker automatically.
 These are the most important `make` targets:
 
 - `build`: build everything
-- `docker`: build the container
-- `container`: restart the development container (or start it if it's not yet)
-- `dev`: does `docker`, `container`, and `build`
 - `test`: run the tests
 - `libp2p_helper`: build the libp2p helper
 - `web`: build the website, including the state explorer
@@ -136,29 +132,13 @@ the submodule's repository, it will be automatically re-pinned in CI.
 
 If you add a new package in the Mina repository or as a submodule, you must do all of the following:
 
-1. Update [`Dockerfile-toolchain`](/dockerfiles/Dockerfile-toolchain) as required; there are
-   comments that distinguish the treatment of submodules from other packages
-2. Update [`scripts/macos-setup.sh`](scripts/macos-setup.sh) with the required commands for Darwin systems
-3. Bust the circle-ci Darwin cache by incrementing the version number in the cache keys as required inside [`.circleci/config.yml.jinja`](.circleci/config.yml.jinja)
-4. Commit your changes
-5. Rebuild the container with `make docker-toolchain`.
-6. Re-render the jinja template `make update-deps`
-7. Commit your changes again
-
-Rebuilding the docker toolchain will take a long time. Running circleci for
-macos once you've busted the cache will also take a long time. However, only
-you have to do the waiting and all other developers will get the fast path.
-
-The automatic re-pinning of modified packages does take some CI time, so eventually,
-you'll want to rebuild the Docker toolchain to save that time.
+1. Update [`scripts/macos-setup.sh`](scripts/macos-setup.sh) with the required commands for Darwin systems
+2. Update [`dockerfiles/stages/`](dockerfiles/stages) with the required packages
 
 ## Common dune tasks
 
 To run unit tests for a single library, do `dune runtest lib/$LIBNAME`.
 
-You can use `dune exec coda` to build and run `coda`. This is especially useful
-in the form of `dune exec coda -- integration-tests $SOME_TEST`.
-
 You might see a build error like this:
 
 ```text
@@ -170,14 +150,6 @@ Error: Files src/lib/mina_base/mina_base.objs/account.cmx
 You can work around it with `rm -r src/_build/default/src/$OFFENDING_PATH` and a rebuild.
 Here, the offending path is `src/lib/mina_base/mina_base.objs`.
 
-## Docker Image Family Tree
-
-Container Stages:
-
-- Stage 0: Initial Image [ocaml/opam2:debian-9-ocaml-4.07](https://hub.docker.com/r/ocaml/opam2/) (opam community image, ~880MB)
-- Stage 1: [coda toolchain](https://github.com/MinaProtocol/coda/blob/master/dockerfiles/Dockerfile-toolchain) (built by us, stored on docker hub, ~2GB compressed)
-- Stage 2: [codabuilder](https://github.com/MinaProtocol/coda/blob/master/dockerfiles/Dockerfile) (built with `make codabuilder`, used with `make build`, ~2GB compressed)
-
 ## Overriding Genesis Constants
 
 Mina genesis constants consists of constants for the consensus algorithm, sizes for various data structures like transaction pool, scan state, ledger etc.

automation/README.md

@@ -5,7 +5,7 @@
 
 # Repository Purpose
 
-This repository is designed to show an opinionated example on how to operate a network of Coda Daemons. It implements the entire node lifecycle using a modern Infrastructure as Code toolset. Community contributions are warmly encouraged, please see the [contribution guidelines](#to-do) for more details. The code is designed to be as modular as possible, allowing the end-user to "pick and choose" the parts they would like to incorporate into their own infrastructure stack.
+This repository is designed to show an opinionated example on how to operate a network of Mina Daemons. It implements the entire node lifecycle using a modern Infrastructure as Code toolset. Community contributions are warmly encouraged, please see the [contribution guidelines](../CONTRIBUTING.md) for more details. The code is designed to be as modular as possible, allowing the end-user to "pick and choose" the parts they would like to incorporate into their own infrastructure stack.
 
 If you have any issues setting up your testnet or have any other questions about this repository, join the public [Discord Server](https://discord.gg/ShKhA7J) and get help from the Coda community.
 
@@ -129,7 +129,7 @@ Next, you must create a new testnet in `terraform/testnets/`. For ease of use, y
 - Name of testnet
 - number of nodes to deploy
 - Location of the Genesis Ledger
-- Kubernetes [context](https://github.com/MinaProtocol/Mina-automation/commit/141db8821a133501d3d4ed9b739fcad1f9b88bef) for indicating which managed *k8s* cluster to deploy to
+- Kubernetes context for indicating which managed *k8s* cluster to deploy to
 
 ### Manage *k8s* Cluster for Deployment
 
@@ -156,7 +156,7 @@ Once decided on a cluster/context to deploy, use the following command to retrie
 
 #### Configure testnet module `k8s_context`
 
-There is a testnet module variable which determines the *Kubernetes* context to deploy to. Reference the module's [variable definitions](https://github.com/MinaProtocol/mina/automation/blob/master/terraform/modules/kubernetes/testnet/variables.tf) for more details on how to properly configure.
+There is a testnet module variable which determines the *Kubernetes* context to deploy to. Reference the module's [variable definitions](./terraform/modules/kubernetes/testnet/variables.tf) for more details on how to properly configure.
 
 ```variable "k8s_context" {
   type = string

automation/services/buildkite/prometheus-exporter/README.md

@@ -46,4 +46,4 @@ docker run --rm --detach --env BUILDKITE_API_KEY="XXXXXXXX" \
 
 ## Metrics
 
-Metrics will be made available on port `8000` by default, or you can pass environment variable ```METRICS_PORT``` to override this. An example printout of the metrics you should expect to see can be found in [METRICS.md](https://github.com/CodaProtocol/coda-automation/blob/master/services/buildkite/prometheus-exporter/METRICS.md).
+Metrics will be made available on port `8000` by default, or you can pass environment variable ```METRICS_PORT``` to override this. An example printout of the metrics you should expect to see can be found in [METRICS.md](METRICS.md).

automation/services/echo/README.md

@@ -4,7 +4,7 @@ This is a simple node service that listens for transactions to a specific addres
 
 ## Usage
 
-First you'll need to have a `coda` daemon running on your machine. See the docs [here](https://codaprotocol.com/docs/getting-started/) for instructions on getting a node, then run the following command:
+First you'll need to have a `mina` daemon running on your machine. See the docs [here](https://docs.minaprotocol.com/en/getting-started/) for instructions on getting a node, then run the following command:
 
 ```
 $ mina daemon -rest-port 49370 -peer beta.o1test.net:8303

automation/services/faucet/README.md

@@ -4,15 +4,15 @@ The faucet service is a simple Discord bot that listens for requests for `CODA`
 
 ## Usage
 
-First you'll need to have a `coda` daemon running on your machine. See the docs [here](https://codaprotocol.com/docs/getting-started/) for instructions on getting a node, then run the following command:
+First you'll need to have a `coda` daemon running on your machine. See the docs [here](https://docs.minaprotocol.com/en/getting-started) for instructions on getting a node, then run the following command:
 
 ```
 $ mina daemon -rest-port 49370 -peer beta.o1test.net:8303
 ```
 
 This process must be running for this service to work. Open a new terminal session before you continue.
 
-The service requires [Python 3.7]() to be installed on your system, and uses [pip]() as the package manager. To make things easy, a docker-compose environment has been provided that allows you to start the service simply. First, copy the example and update your environment variables:
+The service requires Python 3.7 to be installed on your system, and uses pip as the package manager. To make things easy, a docker-compose environment has been provided that allows you to start the service simply. First, copy the example and update your environment variables:
 
 ```
 cp docker-compose.yml.example docker-compose.yml
@@ -30,4 +30,4 @@ environment:
 docker-compose up
 ```
 
-**NOTE:** Host networking is enabled in the example docker-compose file, meaning that host ports will be shared with the container and the daemon can be accessed on `localhost`.
+**NOTE:** Host networking is enabled in the example docker-compose file, meaning that host ports will be shared with the container and the daemon can be accessed on `localhost`.

automation/services/mina-bp-stats/sidecar/README.md

@@ -15,6 +15,7 @@ The sidecar takes 2 approaches to configuration, a pair of envars, or a configur
 - `MINA_NODE_URL` - The URL that the sidecar will reach out to to get statistics from
 
 #### Config File
+[config-file]: #config-file
 The mina metrics sidecar will also look at `/etc/mina-sidecar.json` for its configuration variables, and the file should look like this:
 
 ```
@@ -93,7 +94,7 @@ $ dpkg -i ./mina-bp-stats-sidecar.deb
 
 #### Configuring and Running
 
-See the [Configuration](#Configuration) section above for what should be in the `/etc/mina-sidecar.json` file.
+See the [Config File](#config-file) section above for what should be in the `/etc/mina-sidecar.json` file.
 
 To (optionally) enable the service to run on reboot you can use:
 
@@ -151,4 +152,4 @@ ERROR:root:HTTP Error 400: Bad Request
 ERROR:root:Sleeping for 30s and trying again
 ```
 
-It likely means you're shipping off data to the ingest pipeline without any block producer key configured on your Mina node - since your BP key is your identity we can't accept node data since we don't know who is submitting it!
+It likely means you're shipping off data to the ingest pipeline without any block producer key configured on your Mina node - since your BP key is your identity we can't accept node data since we don't know who is submitting it!

automation/terraform/modules/services/daemon/README.md

@@ -34,7 +34,7 @@ This is a Terraform module that will deploy a mina Daemon container as a service
 
 ## Deployment Considerations
 
-In order to deploy a "new" version of this module, you must ensure that you have rebuilt said container. The container build is a two-step process, with the base mina dockerfile being [here](https://github.com/MinaProtocol/mina/blob/develop/dockerfiles/Dockerfile-mina-daemon) and the more deployment-specific Dockerfile [here](https://github.com/MinaProtocol/mina-automation/blob/master/services/daemon/Dockerfile).
+In order to deploy a "new" version of this module, you must ensure that you have rebuilt said container.
 
 The manual commands to release each container are the following: