nymtech / docs Goto Github PK

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://github.community

BLC_UNKNOWN

View Actions Results

cf. solidity docs versioning at bottom left of screen + warning.

https://docs.soliditylang.org/en/v0.3.1/types.html

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com/en/github/site-policy/github-terms-of-service

HTTP_403

View Actions Results

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com

HTTP_403

View Actions Results

The firewall ports to open are missing in the docs

When you do add name, description to your mixnode, you are required to restart mixnode to make changes take effect.

This should be noted in the documents (and possible in CLI help when you finish interaction with describe subcommand), that you need to restart your mixnode.
@mfahampshire

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com

HTTP_403

View Actions Results

Update the nodesguru link + add nymspy link here: https://nymtech.net/docs/run-nym-nodes/mixnodes/#checking-that-your-node-is-mixing-correctly

Also do a small reword.

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com

HTTP_403

View Actions Results

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com

HTTP_403

View Actions Results

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com/en/github/site-policy/github-privacy-statement

HTTP_403

View Actions Results

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com/en/github/site-policy/github-terms-of-service

HTTP_403

View Actions Results

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com

HTTP_403

View Actions Results

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://github.com/apps/dependabot

HTTP_403

View Actions Results

PR here: #113

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com/en/github/site-policy/github-terms-of-service

HTTP_403

View Actions Results

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com/en/github/site-policy/github-terms-of-service

HTTP_403

View Actions Results

Create a dark version of the video example located here + adapt logic for switching between them from existing diagrams.

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://github.com/apps/dependabot

HTTP_403

View Actions Results

Current design, approach on how to run a mixnode is built around assumption that you should have running, operational, routable mixnode before you "register" it in the mixnet with Bond action.

This seems to be an outdated measure as since the time it was implemented, we now have inactive mixnodes set, we have blacklist for mixnodes which are not routable.

On the counterpart, mixnode docs suggest you to Bond your mixnode before you actually Run it, which triggers WARN message in the mixnode logs. Same message will appear if you restart it (for example to apply changes made with describe command).

Proposed course of action:

1. remove WARN message from logs
   OR
2. edit mixnode documents page to suggest Bonding only after you have set up your mixnode accordingly

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com

HTTP_403

View Actions Results

The Docs only mention a workaround for the ulimit problem for systemd based Distros.
See here.

I suggest to add a workaround for non-systemd based Distros.

Go to
/etc/security/limits.conf and edit as root.

Add the following lines:

## Example hard limit for max opened files
username        hard nofile 4096
## Example soft limit for max opened files
username        soft nofile 4096

The docs say the latest stable version is Version: v1.0.1 (stable), and the precompiled binary are for ubuntu and other Debian systems. As of June 9 v1.0.4 is the latest and Mac, windows binaries have been added.

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://github.com/apps/dependabot

HTTP_403

View Actions Results

Add a searchbar to docs: https://docusaurus.io/docs/search

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com/en/github/site-policy/github-privacy-statement

HTTP_403

View Actions Results

Links on the index.md page are relative and only work if you are on the page
https://nymtech.net/docs/0.11.0/run-nym-nodes/index
(build instructions)
(build instructions)

If you end up on the page with trailing '/' links will lead to incorrect pages
https://nymtech.net/docs/0.11.0/run-nym-nodes/index/build-nym
https://nymtech.net/docs/0.11.0/run-nym-nodes/index/validators

So it should be either changed to absolute paths OR page with '/' in the end should redirect to the one without '/'

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com/en/github/site-policy/github-terms-of-service

HTTP_403

View Actions Results

} - this should be deleted

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com/en/github/site-policy/github-privacy-statement

HTTP_403

View Actions Results

Drop larger chunks of console output into HTML tags

https://www.w3schools.com/tags/tag_details.asp

Currently, we can only learn which version mixnode is running by seeing what node operator has put into Version field.
There are few issues with this:

1. version can be gamed
2. in order to change it after you update the mixnode - you have to unbond, do update, bond again which makes you leave active set for 1 hour (at least). This may hurt node operator reputation as currently mixnode updates are not mandatory and are not announced beforehand so that node operators can prepare to it and alert their delegators on planned technical downtime

Proposal:

1. add version query endpoint for mixnode.
   This will remove necessity to input version in the Bond form and 1hour downtime of mixnodes.
2. set rewards mechanism to only reward mixnodes of latest release version
3. optionally, add version-check in validator-api for uptime measurement module. Only count uptime for latest version of mixnodes
4. prepare workflow which will make mixnode updates more clear with coordination of CMs, prior announcements in the official NYM channels

Repos can feature an URL, put the link to 'rendered' docs at https://github.com/nymtech/docs welcome page

Something hasn't worked properly with https://docs.nymtech.net/zh/docs/stable/developers/develop-with-nym/understanding-nym-apps and a few others - check into merge history

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://github.com/apps/dependabot

HTTP_403

View Actions Results

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com/en/github/site-policy/github-privacy-statement

HTTP_403

View Actions Results

cf. https://discourse.gohugo.io/t/how-to-create-multilevel-dropdown-menu-in-hugo/18373/5

Cleanup old PRs

Something flaked with merging to main so I've temporarily removed it, reintroduce it.

port tables currently default to the entire page width - change this so they are static / columns are at most the size of the widest element

nym validator fails to start unless alternate --grpc.address is used on systems with Cockpit enabled.

Would make it easier if a different port is used or a note added to validator docs

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com

HTTP_403

View Actions Results

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com/en/github/site-policy/github-privacy-statement

HTTP_403

View Actions Results

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com/en/github/site-policy/github-privacy-statement

HTTP_403

View Actions Results

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com

HTTP_403

View Actions Results

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com

HTTP_403

View Actions Results

Broken link found

Broken Link Checker found a broken link on https://github.com/nymtech/docs

Target: https://docs.github.com/en/github/site-policy/github-terms-of-service

HTTP_403

View Actions Results