Skip to content

Correct spelling and Markdown in lidR tutorial - #386

Merged
damianooldoni merged 3 commits into
mainfrom
docs/correct-lidr-tutorial-copy
Oct 28, 2026
Merged

damianooldoni merged 3 commits into
mainfrom
docs/correct-lidr-tutorial-copy

Conversation

Copilot AI commented Oct 27, 2026

Copy link
Copy Markdown

Description

Correct spelling, grammar, LiDAR terminology, and Markdown list formatting in the existing lidR tutorial. Also fix the capitalization and path of its GitHub link.

Related Issue

None.

Task list

  • My tutorial or article is placed in a subfolder of tutorials/content/
  • The novel tutorial has a meaningful name, in relation to the content of the tutorial.
  • The filename of my tutorial or article is index.md. In case of an Rmarkdown tutorial I have knitted my index.Rmd to index.md (both files are pushed to the repo).
  • yaml header:
    • (recommended) I am included as author in the authors yaml tag, using [MY_AUTHOR_ID]. An author information file exists in <tutorials>/data/authors/<author>.toml.
    • I have added categories to the YAML header and my category tags are from the list of categories.
    • I have included meaningful and applicable tags (i.e. keywords) in the YAML header to improve the visibility of the new tutorial (see the tags listed in the tutorials website side bar).
    • The date is in format YYYY-MM-DD and adjusted.
  • (recommended) I have previewed this PR locally (see steps below; ask previous contributors for help) and confirmed that the new content renders as expected.

Previewing the pull request

Thanks to GitHub Actions, an artifact (=zip file) of the rendered website is automatically created for each pull request.
This provides a way to preview how these updates will look on the website, useful to contributors and reviewers.

Instructions to preview the updated website

  1. On the PR page, you can find a "details" link under "checks - On PR, build the site and ...". Go there, click on the top link in the left sidebar ("Summary"), and download the generated artifact at the bottom of the page.
  2. Decompress it into a target directory, e.g. Downloads/tutorials_preview.
  3. To preview the website, use a program which can serve http sites on your local machine. One such option is the servr package in R: & '\C:\Program Files\R\R-4.4.2\bin\Rscript.exe' -e "servr::httd('./tutorials_preview')" -p8887 (make sure to adjust the path to your Rscript.exe; on Linux, simply use Rscript -e [...]).
  4. Point your browser to http://localhost:8887.
  5. Review the updated website. As a contributor, you can push extra commits to update the PR. As a reviewer, you can accept/refuse/comment on it.

Note: for step 3, you can use any other simple HTTP server to serve the current directory, e.g. Python http.server: python -m http.server 8887 --bind localhost --directory path/to/tutorials_preview

Alternative: Locally Building the Site

Alternatively, you can build the entire site locally (see the README for instructions); the Hugo preview server will update changes on the fly.
This requires Hugo to be installed on your computer.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@damianooldoni

Copy link
Copy Markdown
Member

@bserrien: I have screened quite fast the textual improvements and it seems correct. Can you provide a formal review and adjust further where needed? Thanks!

@bserrien bserrien left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All changes proposed by Damiano are okay, thank you Damiano! I also saw that the formatting of the link in the description was not correct. If I had to guess, this is related to Hugo expecting only text in the description, not markdown. I moved it to the introduction where it is formatted correctly. Do you agree?
Image

@damianooldoni

Copy link
Copy Markdown
Member

Hi @bserrien! I agree. Actually the description text should not be too long, so links can be placed in the introduction, for sure. Still, I think that the first sentence could stay in the description as it is very informative and still quite short. Thanks for reviewing.

@damianooldoni

Copy link
Copy Markdown
Member

@bserrien: if you agree, could you please approve this PR? It seems I have no write access to this repository, strange. And a PR can be merged only if reviewers with write access approve it. Thanks.

@damianooldoni

Copy link
Copy Markdown
Member

Thanks @bserrien

@damianooldoni
damianooldoni merged commit ddd9053 into main Oct 28, 2026
1 check passed
@damianooldoni
damianooldoni deleted the docs/correct-lidr-tutorial-copy branch October 28, 2026 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants