Skip to content

docs: Import common best practices from catalogue - #408

Merged
th3james merged 3 commits into
mainfrom
best-practices
Aug 17, 2026
Merged

docs: Import common best practices from catalogue#408
th3james merged 3 commits into
mainfrom
best-practices

Conversation

@th3james

@th3james th3james commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

arm/topo-project-catalog#5 introduced some best practices which were actually common enough to belong in this repo. This PR migrates them here.

arm/topo-project-catalog#10 removes the duplication and cross references the new documentation introduced here.

Changes

  • Add a new best practices guide
  • Update broader documentation to link to best practices at appropriate places
  • Update the skills to accordingly
  • Add links to the catalogue guidance, but make it clear those are additional requirements specific to the catalogue

Checklist

  • 🤖 This change is covered by tests as required.
  • 🤹 All required manual testing has been performed.
  • 📖 All documentation updates are complete.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We are losing the reference to x-topo.features. Is it intentional?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It was. That feature feels a little bit in flux right now and I didn't want to put too much focus on it at present.

@@ -0,0 +1,19 @@
# Topo Project Authoring Best Practices

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Not 100% it's worth including 'Topo' here - same goes for the existing 'Topo Project Authoring guide though'. Feels like it's implied everything is Topo-related in the docs and 'Project' is already a reserved noun in isolation.

Image

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@th3james
th3james merged commit c5f06c0 into main Aug 17, 2026
10 of 11 checks passed
@th3james
th3james deleted the best-practices branch August 17, 2026 15:14
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.

3 participants