added getting started guide

OnionIoT / documentation

Documentation for the Omega2 beta firmware

0 stars 1 forks source link

added getting started guide #41

Closed iammuze closed 5 months ago

iammuze commented 5 months ago

Hi, @greenbreakfast Getting Started Guide has been added to issue #28 , please review it.

iammuze commented 5 months ago

Hi @greenbreakfast, it appears that a check has failed in the pull request. Could you please take a look and address any issues?

greenbreakfast commented 5 months ago

hi @iammuze, like I mentioned in my last comment in issue 28, this content should be in docs/packages/intro.md

Please make the following changes:

Move the written content to docs/packages/intro.md
Undo the changes to sidebars.js since the packages intro is already included
In order to make the images more maintainable, move the images to an assets directory that's in the same directory as the article.
- See the pin multiplexing article for details: 1) how to include images in the article, 2) where the assets directory should be

iammuze commented 5 months ago

Oh, I got confused. So, the content of this getting started guide will be reflect similar to the Device Tree Overlays chapter, right?

greenbreakfast commented 5 months ago

Yep that’s right On Feb 7, 2024, at 12:03 PM, Muze @.***> wrote: Oh, I got confused. So, the content of this getting started guide will be reflect similar to the Device Tree Overlays chapter, right?

—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: @.***>

iammuze commented 5 months ago

Hi @greenbreakfast now, the content has been moved into docs/packages/intro.md and the changes in sidebar.js have been undone. please review it.

aws-amplify-us-east-1[bot] commented 5 months ago

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-41.d2l2d7l06y6q7u.amplifyapp.com

iammuze commented 5 months ago

The build issue was happening because the packages branch didn't have the comment section implementation. I fixed that with a rebase. Added comments to the content - please take a look

Yeah, I also set up the GiscusComment package locally, but I didn't push it. I was thinking it might be a duplicate, but you resolved this issue. Thanks for that.

greenbreakfast commented 5 months ago

Looks good, merging these changes to main branch to publish the article