DOCS-2557: Add architecture to platform reference page #3251
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
viambot
added
the
safe to build
npentrel
reviewed
Aug 14, 2024
docs/platform.md
Outdated
| Some are built-in, and many more are available in the registry. | ||
| You can also write your own and add them to the registry. | ||
|
|
||
| In addition to modular components and services, the registry contains ML models. |
There was a problem hiding this comment.
Suggested change
| In addition to modular components and services, the registry contains ML models. |
True but also training scripts. I think let's gloss over this
docs/platform.md
Outdated
Comment on lines
32
to
37
| {{< cards >}} | ||
| {{% card link="/architecture/" %}} | ||
| {{% card link="/configure/" %}} | ||
| {{% card link="/fleet/" %}} | ||
| {{% card link="/cloud/" %}} | ||
| {{% card link="/fleet/" %}} | ||
| {{< /cards >}} |
There was a problem hiding this comment.
I think the cards aren't actually helpful here and just take up space, let's take them out and just use the table
docs/platform.md
Outdated
Comment on lines
47
to
51
| {{< cards >}} | ||
| {{% card link="/components/" %}} | ||
| {{% card link="/services/" %}} | ||
| {{% card link="/registry/" %}} | ||
| {{< /cards >}} |
There was a problem hiding this comment.
We could try how it looks with smaller cards and listing these out something like
Suggested change
| {{< cards >}} | |
| {{% card link="/components/" %}} | |
| {{% card link="/services/" %}} | |
| {{% card link="/registry/" %}} | |
| {{< /cards >}} | |
| On your machine, you can configure the following components: | |
| {{< cards >}} | |
| {{% relatedcard link="/components/arm" %}} | |
| {{% relatedcard link="/components/base" %}} | |
| {{% relatedcard link="/components/board" %}} | |
| {{% relatedcard link="/components/camera" %}} | |
| {{% relatedcard link="/components/encoder" %}} | |
| {{% relatedcard link="/components/gantry" %}} | |
| {{% relatedcard link="/components/generic" %}} | |
| {{% relatedcard link="/components/gripper" %}} | |
| {{% relatedcard link="/components/input-controller" %}} | |
| {{% relatedcard link="/components/motor" %}} | |
| {{% relatedcard link="/components/movement-sensor" %}} | |
| {{% relatedcard link="/components/power-sensor" %}} | |
| {{% relatedcard link="/components/sensor" %}} | |
| {{% relatedcard link="/components/servo" %}} | |
| {{< /cards >}} | |
| And you can use the following platform capabilities and services to make your machines smarter and better: | |
| {{< cards >}} | |
| {{% relatedcard link="/services/data" %}} | |
| {{% relatedcard link="/services/ml" %}} | |
| {{% relatedcard link="/services/motion" %}} | |
| {{% relatedcard link="/services/navigation" %}} | |
| {{% relatedcard link="/services/slam" %}} | |
| {{% relatedcard link="/services/vision" %}} | |
| {{< /cards >}} | |
| ... |
JessamyT
commented
Aug 15, 2024
npentrel
reviewed
Aug 15, 2024
assets/platform/cli.png
Outdated
npentrel
reviewed
Aug 15, 2024
| @@ -3,7 +3,7 @@ title: "Components" | |||
| linkTitle: "Components" | |||
| weight: 410 | |||
| type: docs | |||
| description: "In-depth information on the various components available within the Viam system." | |||
| description: "Components are software packages that drive hardware such as sensors, motors, cameras, and robotic arms." | |||
npentrel
reviewed
Aug 15, 2024
npentrel
reviewed
Aug 15, 2024
npentrel
approved these changes
Aug 15, 2024
JessamyT
commented
Aug 15, 2024
Co-authored-by: Naomi Pentrel <[email protected]>
JessamyT
commented
Aug 15, 2024
JessamyT
commented
Aug 15, 2024
|
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3251 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.