Skip to content

docs: add Topo glossary#269

Merged
ZachMaso merged 1 commit into
arm:mainfrom
ZachMaso:docs/add-glossary
May 27, 2026
Merged

docs: add Topo glossary#269
ZachMaso merged 1 commit into
arm:mainfrom
ZachMaso:docs/add-glossary

Conversation

@ZachMaso
Copy link
Copy Markdown
Contributor

Changes

  • Add docs/glossary.md with definitions for core Topo concepts.
  • Link to the glossary from the README after the "Who is this for?" section.

Validation

  • Documentation-only change; no code tests run.

@ZachMaso ZachMaso force-pushed the docs/add-glossary branch from 415fec0 to 87449b5 Compare May 19, 2026 13:33
@ZachMaso
Copy link
Copy Markdown
Contributor Author

A few terms we may need to adjust more widely across the docs due to this:

  1. target host - should this be referred to as 'target system processor'?
  2. local host - should this be referred to as just 'host'?
  3. x-Topo - should we always refer to this as 'x-topo' or 'x-Topo'?
  4. service templates - should these always be referred to as 'templates' or 'topo templates' or is this a different thing?

@ZachMaso
Copy link
Copy Markdown
Contributor Author

Suggested reviewers: @Luke-Parkin and @th3james.

@ZachMaso ZachMaso marked this pull request as ready for review May 19, 2026 13:50
@ZachMaso ZachMaso requested a review from a team as a code owner May 19, 2026 13:50
Comment thread docs/glossary.md Outdated
Comment thread README.md
@ZachMaso ZachMaso force-pushed the docs/add-glossary branch from 87449b5 to 4db15c3 Compare May 20, 2026 08:08
Comment thread docs/glossary.md
Comment thread docs/glossary.md Outdated
Comment thread cmd/topo/setup_keys.go Outdated
Comment thread cmd/topo/vscode.go Outdated
Comment thread docs/glossary.md Outdated
@ZachMaso ZachMaso force-pushed the docs/add-glossary branch from 4db15c3 to e70bc91 Compare May 20, 2026 09:57
Comment thread cmd/topo/deploy.go Outdated
@ZachMaso ZachMaso force-pushed the docs/add-glossary branch 5 times, most recently from ec94805 to ec8a55a Compare May 21, 2026 13:00
Copy link
Copy Markdown
Contributor

@yejseo01 yejseo01 left a comment

Choose a reason for hiding this comment

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

I think this is a big improvement! Thanks Zach!

@ZachMaso ZachMaso force-pushed the docs/add-glossary branch from ec8a55a to b923837 Compare May 21, 2026 14:34
Copy link
Copy Markdown
Contributor Author

@ZachMaso ZachMaso left a comment

Choose a reason for hiding this comment

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

Have addressed all comments and made changes accordingly.

Copy link
Copy Markdown
Contributor

@awphi awphi left a comment

Choose a reason for hiding this comment

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

lgtm!

@ZachMaso ZachMaso force-pushed the docs/add-glossary branch 2 times, most recently from 6d1fe03 to 7898d56 Compare May 27, 2026 09:16
Signed-off-by: Zach Mason <zach.mason@arm.com>
@ZachMaso ZachMaso force-pushed the docs/add-glossary branch from 7898d56 to 22af4a8 Compare May 27, 2026 09:34
@ZachMaso ZachMaso merged commit 6303d4c into arm:main May 27, 2026
5 checks passed
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.

6 participants