• Create a more appealing frontpage that tells the visitor a bit better what we have to offer.
• Provide simple installation instructions. Part of this initiative is building proper release artifacts in the pipeline (see #1721).
• Make the entry into probe-rs usage even easier.
  • Explain how one uses probe-rs run properly.
  • How to troubleshoot
    • How to enable logs
    • What are common errors
      • Can we also add hints in our error messages
  • Clean up docs a lot and explain in more detail.
• Add a searchable list of provided targets with information about each target.

Install deno which is the JS runtime to generate all webpage docs.

Then locally serve the documentation from the root of this repository. Be patient, it may take a while on the first run.

$ deno task serve

When the documentation preview is ready and gets served, you will be greeted with something like:

🍾 Site built into ./target
  129 files generated in 62.64 seconds

  Server started at:
  https://localhost:3000/ (local)
  https://192.0.2.3:3000/ (network)

When doing heavy development, you might end in the need to provide a GitHub API Token (for fetching the probe-rs repository in the background). See here for how to get yours, save it to a file like ~/.probe-rs-github-token and provide it to deno via the environment variable GITHUB_TOKEN as follows:

$ export GITHUB_TOKEN=$(cat ~/.probe-rs-github-token)