[ralphweng2023]

Description

Adds the missing 03 page to Usage Examples: "Your first usage example, start to finish". It walks through one usage example from a fresh clone to a pushed branch, with 31 screenshots and tabbed code for C++, C# and Python.

It also covers two things no page mentioned: npm run dev stops unless a .env file holds three DOCSEARCH settings, and running programs inside the repo leaves untracked files behind (banner.dSYM, __pycache__, logs and myeasylog.log).

The page links to the existing setup, GitHub, pull request, style guide and peer review pages instead of repeating them.

Type of change

• Documentation (update or new)

How Has This Been Tested?

Ran npm run dev and checked the page in Chrome: the tabs, the callouts, the troubleshooting table, and that every image loads. npm run build passes and every internal link is valid. npm run format:check passes. Vale reports no errors on a .md copy of the page. CI's Vale config only matches .md files, so it does not lint .mdx pages.

Testing Checklist

• Have run npm run format
• Have run npm run build
• Have run npm run dev and/or npm run preview, using:
  • Chrome
  • Safari
  • Firefox

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have requested a review from ... on the Pull Request

Planner card: Add a start-to-finish guide for a first usage example to the docs site

[netlify]

✅ Deploy Preview for thoth-tech ready!

Name	Link
🔨 Latest commit	874f247
🔍 Latest deploy log	https://app.netlify.com/projects/thoth-tech/deploys/6ab5986ad1bd8400088dd429
😎 Deploy Preview	https://deploy-preview-189--thoth-tech.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[owens-hub-git]

I pulled this request locally to test it and couldn't find issues with it. It's quite comprehensive with a long guide that responds at each step with things that go wrong and what to do when it goes wrong.

The only thing I recommend is creating subfolders in the images tab because there are a lot of images that are specific to this example where other images are for different tabs.

But yeah looks good otherwise

[ralphweng2023]

Thanks for testing it locally @owens-hub-git. The 31 images for this guide are now in images/first-usage-example/ (a03fd92), so the images for the other tabs stay where they were. Only the paths changed and the CI build passes.

[Osaid2993]

Thorough guide with good troubleshooting coverage. The .env and untracked files callouts are useful since those aren't documented anywhere else. Image subfolder change looks clean.

[owens-hub-git]

So this is good in terms of moving pictures into a seperate folder, but it fails as pointed out by the red crosses because:
in 03-your-first-usage-example.mdx, you need to update how you reference the images.

For example: instead of 'images/first-example-commit.png' it should be 'images/first-usage-example/first-example-commit.png'

This is for every picture tag just append that name "first-image-usage" to the source because the place where the images reside is no longer just in the images folder.

Hope this makes sense, if not let me know.

[ralphweng2023]

Thanks @owens-hub-git, you were right about the paths. My last commit moved the images but left out the edit to 03-your-first-usage-example.mdx, so the guide still pointed at the old folder. That is fixed in 874f247: all 32 image references now use images/first-usage-example/, and the build and deploy preview pass.

[owens-hub-git]

Thanks for updating, it's passing tests and looks ok now.
Well done

[jankiluitel]

Reviewed the latest changes. The guide is comprehensive and beginner-friendly, with clear step-by-step instructions, useful troubleshooting notes, and good links to the existing setup and style documentation.

I also checked the latest image-path update, and the guide now references the images from the images/first-usage-example/ subfolder as intended.

The previous review feedback has been addressed and the checks are passing. Nice work on putting together such a detailed start-to-finish guide.