Skip to content

Conversation

@KrishnaIyer
Copy link
Contributor

@KrishnaIyer KrishnaIyer commented Jul 14, 2025

Summary

Update getting started section. References: https://github.com/TheThingsIndustries/product-management/issues/68

Screenshots

Screen Shot 2025-07-14 at 16 14 33 Screen Shot 2025-07-14 at 16 14 36 Screen Shot 2025-07-14 at 16 14 39 Screen Shot 2025-07-14 at 16 14 42 Screen Shot 2025-07-14 at 16 14 49

Changes

  • Rework the getting started section

Checklist

  • Scope: The referenced issue is addressed, there are no unrelated changes.
  • Run Locally: Verified that the docs build using make server, posted screenshots, verified external links. Test with HUGO_PARAMS_SEARCH_ENABLED=true if style changes will affect the search bar.
  • New Features Marked: Documentation for new features is marked using the new-in-version shortcode, according to the guidelines in CONTRIBUTING.
  • Style Guidelines: Documentation obeys style guidelines in CONTRIBUTING.
  • Commits: Commit messages follow guidelines in CONTRIBUTING, there are no fixup commits left.

@KrishnaIyer KrishnaIyer self-assigned this Jul 14, 2025
@KrishnaIyer KrishnaIyer marked this pull request as ready for review July 14, 2025 14:16
@KrishnaIyer KrishnaIyer requested a review from happyRip as a code owner July 14, 2025 14:16
@happyRip happyRip requested a review from Copilot July 17, 2025 10:59
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR restructures the “Getting Started” section into a clear four‐step workflow, replaces legacy introductory pages with new step‐based content, and updates navigation links and weights to align with the new structure.

  • Rework getting started into four sequential steps (1–4) with renamed pages and updated titles/aliases
  • Remove old “the-things-stack-basics” and “lorawan-basics” pages in favor of new step-based guides
  • Update navigation (weights, aliases, links) in theme and cloud concept pages

Reviewed Changes

Copilot reviewed 16 out of 60 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
doc/themes/the-things-stack/layouts/index.html Point “Set up your first LoRaWAN® network” link to step 2
doc/content/getting-started/the-things-stack-basics/_index.md Remove legacy The Things Stack basics page
doc/content/getting-started/lorawan-basics/_index.md Remove legacy LoRaWAN basics guide
doc/content/getting-started/glossary/_index.md Add weight for ordering in Getting Started nav
doc/content/getting-started/faq/_index.md Update FAQ description and weight
doc/content/getting-started/_index.md Restructure overview, update description, steps, aliases
doc/content/getting-started/4-next-steps/_index.md Rename title to “Step 4: Next steps” and adjust items
doc/content/getting-started/3-try-starter-kit/troubleshooting/_index.md Add new troubleshooting page
doc/content/getting-started/3-try-starter-kit/control-remotely/_index.md Add guide for sending downlinks to the end device
doc/content/getting-started/3-try-starter-kit/collect-visualize-data/_index.md Add guide for data collection and visualization
doc/content/getting-started/3-try-starter-kit/activate/_index.md Add activation guide for gateway and end device
doc/content/getting-started/3-try-starter-kit/_index.md Create index for Starter Kit workflow
doc/content/getting-started/2-prerequisites/_index.md Rename and re-alias setup network page to step 2
doc/content/getting-started/1-understand-lorawan/_index.md Add new LoRaWAN fundamentals guide as step 1
doc/content/concepts/_index.md Update alias/link for basics to new step 2 prerequisites
doc/content/cloud/_index.md Update Cloud “get started” link to step 2
Comments suppressed due to low confidence (4)

doc/content/getting-started/3-try-starter-kit/troubleshooting/_index.md:1

  • Add a weight property in the front matter to ensure this page is ordered correctly in the Getting Started menu.
---

doc/content/getting-started/3-try-starter-kit/control-remotely/_index.md:19

  • [nitpick] This step is redundant with the instruction at line 15. Consider removing the duplicate to avoid confusion.
In {{% tts %}} Console, select your application and go to the end device overview.

doc/content/getting-started/_index.md:13

  • Alias is missing a trailing slash, which may break redirects. Consider using /getting-started/what-is-tts/ to match folder conventions.
    /getting-started/what-is-tts/,

doc/content/getting-started/3-try-starter-kit/troubleshooting/_index.md:30

  • </br> is not a valid closing tag. Use <br/> or remove the closing tag to correct the HTML.
</br>

Copy link
Member

@happyRip happyRip left a comment

Choose a reason for hiding this comment

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

The new Getting Started section looks great.

I have a couple suggestions along with some nits Copilot found.

Co-authored-by: Copilot <[email protected]>
@happyRip happyRip merged commit 53ed7d0 into master Jul 21, 2025
1 check passed
@happyRip happyRip deleted the starter branch July 21, 2025 10:22
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