Skip to content

Clean up topic page labels and link hierarchy#859

Open
PRAteek-singHWY wants to merge 1 commit intoOWASP:mainfrom
PRAteek-singHWY:fix/186-topic-page-cleanup
Open

Clean up topic page labels and link hierarchy#859
PRAteek-singHWY wants to merge 1 commit intoOWASP:mainfrom
PRAteek-singHWY:fix/186-topic-page-cleanup

Conversation

@PRAteek-singHWY
Copy link
Copy Markdown
Contributor

@PRAteek-singHWY PRAteek-singHWY commented Apr 3, 2026

Summary

fixes #186

Implements topic-page clarity improvements requested in #186 by reducing CRE jargon, improving hierarchy wording, and making topic navigation clearer.

Scope

  • Frontend-only changes
  • No backend schema/migration changes
  • Focused to topic/standard display language and topic tree behavior

What Changed

  1. Wording updates
  • is linked to sources -> refers to sources
  • is part of ... -> is child of ...
  • is linked from ... -> is referenced by ...
  • Replaced CREs phrasing in link-section labels with Requirements
  1. Topic naming cleanup
  • Removed CRE id/prefix style from topic list rows/hyperlinks (show topic names directly)
  1. Block ordering
  • Reordered sections so Linked To appears before Contains
  1. Related topics behavior
  • Related topic nodes collapse by default
  1. Topic reference UX
  • Added external-link icon next to reference links on topic pages
  1. Visual clarity
  • Added indentation/border styling to make link-type sections easier to scan

Files Changed

  • application/frontend/src/const.ts
  • application/frontend/src/utils/document.ts
  • application/frontend/src/components/DocumentNode/DocumentNode.tsx
  • application/frontend/src/components/DocumentNode/documentNode.scss
  • application/frontend/src/pages/Explorer/explorer.tsx
  • application/frontend/src/pages/CommonRequirementEnumeration/CommonRequirementEnumeration.tsx
  • application/frontend/src/providers/DataProvider.tsx

Manual Verification (Before vs After)

1) Topic page basic cleanup

Path

  • Before: https://www.opencre.org/cre/546-564
  • After: http://localhost:9001/cre/546-564

Verify

  • Subheading:
    • Before: CRE: 546-564
    • After: ID: 546-564
  • Child rows:
    • Before: CRE : 028-727 : CSRF protection
    • After: CSRF protection
  • Section title:
    • Before: Which contains CREs
    • After: Which contains Requirements

Screenshots

  • Before: image
  • After: image

2) Wording + related behavior + topic naming

Path

  • Before: https://www.opencre.org/cre/155-155
  • After: http://localhost:9001/cre/155-155

Verify

  • Link heading text:
    • Before: Which is linked to sources
    • After: Which refers to sources
  • Parent heading text:
    • Before: Which is part of CREs
    • After: Which is child of Requirements
  • Related block behavior:
    • Related topic nodes are collapsed by default
  • Topic line naming:
    • Name shown without CRE : xxx-xxx prefix

Screenshots

  • before:
    image
  • after:
    image

3) Block order (Linked first, Contains below)

Path

  • Before: https://www.opencre.org/cre/326-704
  • After: http://localhost:9001/cre/326-704

Verify

  • Order:
    1. refers to sources block
    2. contains Requirements block
  • Visual block clarity/indent is stronger on local build

Screenshots

  • before:
    image
  • after: image

4) Standard-page wording

Path

  • Before: https://www.opencre.org/node/standard/OWASP%20Top%2010%202021/section/Insecure%20Design
  • After: http://localhost:9001/node/standard/OWASP%20Top%2010%202021/section/Insecure%20Design

Verify

  • Standard page heading text:
    • Before: Which is linked from CREs
    • After: Which is referenced by Requirements

Screenshots

  • before: image
  • after: image

5) Explorer list cleanup

Path

  • Before: https://www.opencre.org/explorer
  • After: http://localhost:9001/explorer

Verify

  • Topic entries do not show id prefix like 546-564:
  • Topic text shows clean names only

Screenshots

  • before: [image
  • after: image

Notes

@PRAteek-singHWY
Copy link
Copy Markdown
Contributor Author

Hi @robvanderveer @northdpole @Pa04rth, sharing this PR for #186.

I implemented the requested topic-page cleanup items (wording updates, hierarchy label/order changes, default collapse for related topics, and reference icon improvements).
The PR description is a bit long because I added before/after screenshots for each requirement so review can be done against clear proof.

Could you also please confirm whether #186 is still considered active/relevant in the current roadmap?
If yes, this PR is intended as a direct implementation of those requirements.

Happy to make any refinements based on your feedback. Thanks!

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.

Clean up topic page and make more clear

1 participant