Skip to content

docs: update org readme wording and consolidate architecture references - #222

Merged
marcusburghardt merged 1 commit into
complytime:mainfrom
marcusburghardt:docs/update-org-readme
Sep 8, 2026
Merged

docs: update org readme wording and consolidate architecture references#222
marcusburghardt merged 1 commit into
complytime:mainfrom
marcusburghardt:docs/update-org-readme

Conversation

@marcusburghardt

Copy link
Copy Markdown
Member

Description

This PR updates the org profile/README.md with wording refinements and consolidates the architecture section to avoid content duplication.

Changes from draft PR #53

Applies the still-valid wording refinements originally proposed by @hbraswelrh:

  • Replace "added burden" with "afterthought"
  • Remove duplicate "We believe..." sentence from the About section (it was repeated in the Philosophy section)
  • Replace "microservice-based" with "interoperable"

Additional improvements

  • Consolidate architecture references: Replace the inline component list with a reference to the canonical architecture document in complytime/complytime. The inline list was already stale (complybeacon was renamed to complytime-collector-components, complyscribe was archived, and newer repos like complypack, complyapi, complytime-providers, and complytime-policies were missing).
  • Remove stale commented-out FAQ: The commented-out FAQ section contained outdated content and added noise to the source file.

Supersedes #53

Apply valid wording refinements from draft PR complytime#53:
- Replace 'added burden' with 'afterthought'
- Remove duplicate sentence from About section
- Replace 'microservice-based' with 'interoperable'

Additional improvements:
- Replace inline component list with reference to the canonical
  architecture document in complytime/complytime, eliminating
  duplication that was already stale (complybeacon renamed,
  complyscribe archived, newer repos missing)
- Remove outdated commented-out FAQ section

Supersedes: complytime#53

Signed-off-by: Marcus Burghardt <maburgha@redhat.com>
Assisted-by: OpenCode (claude-opus-4-6)
Signed-off-by: Marcus Burghardt <maburgha@redhat.com>

@gxmiranda gxmiranda left a comment

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.

LGTM

@marcusburghardt
marcusburghardt merged commit 0866a5e into complytime:main Sep 8, 2026
14 checks passed
@marcusburghardt
marcusburghardt deleted the docs/update-org-readme branch September 8, 2026 11:01
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