lf-lang / lf-lang/embedded-lab

Suggestions for minor improvements to the documentation

Open
#24 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
3
Forks
12
Avg merge
13h 2m
Merged PRs (30d)
3

Description

While going through the documentation, I found some small issues that I do not know the exact answers to, so I wanted to leave them here for clarification before trying to fix these myself:

All in in 3. Tools and Environments:

  • the links to "Installation Instructions" and "Resources" lead to non-existent pages, where should they lead instead?
  • when using the nix setup, it seems to be necessary to follow the pico-examples readme first and install this:
sudo apt install cmake gcc-arm-none-eabi libnewlib-arm-none-eabi libstdc++-arm-none-eabi-newlib
  • in the "Using VS Code" section it might be good to and another hint that nix develop needs to be executed first in the lf-3pi repository first as well.
  • using screen may skip some outputs that are not shown on the computer's terminal. I don't know the exact reason why this is, but an explanation for that could help the reader.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the documentation's "3. Tools and Environments" section, checking the "Installation Instructions," "Resources," "Using VS Code," and screen-related guidance. Verify the correct links and setup prerequisites, then confirm the explanation for missing screen output with the project maintainers. Done means each question has an agreed answer and the documentation reflects it.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake, vscode
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.