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

Update sdk guides #309

Merged
merged 8 commits into from
Dec 4, 2023
Merged

Update sdk guides #309

merged 8 commits into from
Dec 4, 2023

Conversation

szczys
Copy link
Collaborator

@szczys szczys commented Nov 27, 2023

This is the final PR that involves large structural changes.

  • Use platform-specific build-environment guides rather than device-specific
  • Platform guides should live in the Getting Started section

Copy link

github-actions bot commented Nov 27, 2023

Visit the preview URL for this PR (updated for commit 41f0485):

https://golioth-docs-dev--pr309-szczys-update-sdk-gu-wkxgm7b6.web.app

(expires Wed, 03 Jan 2024 14:44:57 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: f53b02bdc98ce6f5593931ec4c339aa96bac84df

@szczys szczys force-pushed the szczys/update-sdk-guides branch 6 times, most recently from 7d212dd to 824acc3 Compare November 30, 2023 20:28
Signed-off-by: Mike Szczys <mike@golioth.io>
Detail how to setup a build environment for Golioth and Zephyr/NCS that is not
device specific.

Signed-off-by: Mike Szczys <mike@golioth.io>
These sections are now available as a generalized installation in the Firmware
section for the Golioth Zephyr SDK.

Signed-off-by: Mike Szczys <mike@golioth.io>
Detail how to setup a build environment for ESP-IDF that is not
device specific.

Signed-off-by: Mike Szczys <mike@golioth.io>
Setting up a build environment is part of getting started. The firmware section
will eventually include an "add Golioth to an existing project" section.

Signed-off-by: Mike Szczys <mike@golioth.io>
The guides for setting up platform development have been moved to the Getting
Started section.

The firmware section will eventually have "How to add Golioth to your existing
<platform_name> project" guides. But those will be the result of future
improvement efforts.

Signed-off-by: Mike Szczys <mike@golioth.io>
Getting started houses the platform setup and sample compilation guides. This
commit move the ESP-IDF guides from the hardware section into getting started.

Signed-off-by: Mike Szczys <mike@golioth.io>
@szczys szczys force-pushed the szczys/update-sdk-guides branch from 824acc3 to eccae36 Compare December 1, 2023 20:16
@szczys szczys marked this pull request as ready for review December 1, 2023 20:21
@szczys szczys requested a review from ChrisGammell December 1, 2023 20:21
small fix to grammar
Copy link
Contributor

@ChrisGammell ChrisGammell left a comment

Choose a reason for hiding this comment

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

Added one small grammar fix. Otherwise looks great!

@ChrisGammell ChrisGammell merged commit f85b88b into develop Dec 4, 2023
2 checks passed
@ChrisGammell ChrisGammell deleted the szczys/update-sdk-guides branch December 4, 2023 14:45
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.

2 participants