Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add general best practices #1289

Merged
merged 3 commits into from
Jun 22, 2024
Merged

Conversation

nejraselimovic
Copy link
Contributor

@nejraselimovic nejraselimovic commented Mar 17, 2024

Summary

Closes #1269

Notes for Reviewers

If you think something else could be interesting here, it's open for suggestions

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.

@nejraselimovic nejraselimovic added this to the Mar 2024 milestone Mar 17, 2024
@nejraselimovic nejraselimovic self-assigned this Mar 17, 2024
@KrishnaIyer KrishnaIyer modified the milestones: Mar 2024, Apr 2024 Apr 4, 2024
@nejraselimovic nejraselimovic marked this pull request as ready for review June 2, 2024 19:18
Copy link
Contributor

@KrishnaIyer KrishnaIyer left a comment

Choose a reason for hiding this comment

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

This is pretty good 👍


## Why to use LoRaWAN and {{% tts %}} for your next IoT use case?

LoRaWAN is a communication protocol that has proven advantage in transmitting small sensor data packets over long distances in comparison to other wireless technologies, which makes it great for various use cases, especially industrial deployments. {{% tts %}} is a complete LoRaWAN Network Server that enables you to easily utilize LoRaWAN features to build your use case, while being fully compliant to the LoRa Alliance specifications.
Copy link
Contributor

Choose a reason for hiding this comment

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

a proven advantage. Also please use the registered ® symbol for the first instance of LoRaWAN.

@nejraselimovic nejraselimovic merged commit 4aede38 into master Jun 22, 2024
1 check passed
@nejraselimovic nejraselimovic deleted the issue/update-best-practices branch June 22, 2024 07:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document Best Practices of The Things Stack and LoRaWAN
2 participants