Code Monkey home page Code Monkey logo

webpage's Introduction

The new probe.rs webpage

Goals

  • 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.

Development

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:
  http://localhost:3000/ (local)
  http://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)

webpage's People

Contributors

adamgreig avatar bors[bot] avatar bugadani avatar burrbull avatar dbrgn avatar dependabot[bot] avatar dirbaio avatar disasm avatar ehntoo avatar hargonix avatar iliis avatar joelsa avatar noppej avatar parkero avatar prabhpreet avatar qwandor avatar regexident avatar seanmlyons22 avatar sergiogasquez avatar sethp avatar sirhcel avatar soulsharer avatar tedbyron avatar tgross35 avatar thadhouse avatar thefaxman avatar tiwalun avatar tuxiqae avatar xristos-sk avatar yatekii avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

webpage's Issues

Use permanent link to latest release

I could not figure out how the current link to the installer script works, but it could just be replaced by a link to

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/probe-rs/probe-rs/releases/latest/download/probe-rs-installer.sh | sh

Link to target-gen outdated

Describe the bug
In the library's quickstart documentation there is an outdated link pointing to a moved repository.

The "Downloading to flash" section currently reads

Any target that has a CMSIS-Pack can be converted into a probe-rs flash download target with our utility

with "utility" pointing to https://github.com/probe-rs/target-gen.

To Reproduce
Open the quickstart chapter in a browser.

Expected behavior
Above link (i.e. the term "utility") should point to https://github.com/probe-rs/probe-rs/tree/master/target-gen

Recommend J-Link Conifigurator over Zadig to install generic WinUSB driver

The documentation recommends Zadig to install a generic WinUSB driver for J-Link devices on Windows:
https://probe.rs/docs/getting-started/probe-setup/#windows-1

In my opinion, the J-Link Configurator should be the preferred tool since it is published by Segger and supports this functionality (it is also pretty easy to make mistakes with Zadig). In addition, J-Link Configurator is probably the easiest tool to use to restore the J-Link USB driver, should someone need to do so in the future.

This is the home page for the tool itself: https://www.segger.com/products/debug-probes/j-link/tools/j-link-configurator/
And a wiki article showing how to configure a probe to use WinUSB: https://wiki.segger.com/J-Link_on_Windows_ARM

Incorrect docs

Describe the bug
On https://probe.rs/docs/knowledge-base/troubleshooting/ it says you should write rttEnabled: true, but it's set outside of the object in the "coreConfigs" array which seems to be incorrect.

"configurations": [{
// SNIP...
"rttEnabled": true,
// SNIP...
"coreConfigs": [{
    // SNIP ...,
    "options": {
        "env": {
            "DEFMT_LOG": "Trace" // Trace, Debug, Info, Warn, Error
            }
        },
    }
],
"consoleLogLevel": "Console", //Console, Info, Debug

To Reproduce
Follow the documentation.

Additional context
The JSON in the docs doesn't have balanced open/close brackets. The lack of indentation doesn't help with making it clear what properties go inside what objects. The uppercase first letter in "Trace" is non-conventional for Rust (and as far as I can tell, not necessary?). I'm not sure if rttEnabled is actually supposed to be outside of coreConfigs, from looking at this it seems not?

Suggested fix
Something like this might be nicer

{
    "version": "0.2.0",
    "configurations": [{
        // SNIP...
        "coreConfigs": [{
            // SNIP ...,
            "options": {
                "env": {
                    "DEFMT_LOG": "trace" // trace, debug, info, warn, error
                }
            },
            "rttEnabled": true
        }],
        "consoleLogLevel": "Console" //Console, Info, Debug
    }]
}

Correct `probe.rs/docs/getting-started/installation` package dependencies

The probe.rs website reports different dependent packages for Ubuntu compared to the README.md:

# probe.rs
sudo apt install -y pkg-config libusb-1.0-0-dev libftdi1-dev
# README.md
sudo apt install -y libusb-1.0-0-dev libftdi1-dev libudev-dev libssl-dev
  • libssl-dev is a required dependency which provides access to openssl
  • lib-udev is required by the libudev-sys crate

This was particularly painful for me because compiling code on my Raspberry Pi takes ~10 minutes, and I ended up recompiling code 3-4 installing missing dependencies.

I couldn't find the source code for probe.rs, but I'd be happy writing a PR for it if you could point me to the file.

Current documentation to `cargo install probe-rs-tools` fails due to #2613

Describe the bug
The documentation at https://probe.rs/docs/getting-started/installation/#installation says to install from source, run cargo install probe-rs-tools. However, this fails due to probe-rs/probe-rs#2613.

Since this issue is closed, a new release should be made with the fix in place, or the documentation should be updated to remove the suggestion to run cargo install probe-rs-tools, or it should add --locked to the normal release.

To Reproduce
Steps to reproduce the behavior:

  1. Run cargo install probe-rs-tools or cargo install probe-rs-tools --force

Expected behavior
The software should install.

Desktop (please complete the following information):

  • macOS Mojave

Additional context
The command cargo install probe-rs-tools --force --locked works. Omitting --locked causes the failure, but the documentation only says to include --locked when building the nightly version.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.