Skip to content

Commit 913d587

Browse files
committed
updated the abstract
1 parent 831c5f0 commit 913d587

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

docs/source/index.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@
1212

1313
.. div:: sd-fs-5 sd-font-italic
1414

15-
``Sphinx-CodeLinks`` is designed for Engineering-as-Code workflows to facilitate Application Lifecycle Management (ALM).
16-
It enables users to define ``Sphinx-Needs`` need items within source code using a single line and automatically extract them
17-
into the documentation during the Sphinx build process.
15+
``Sphinx-CodeLinks`` is a lightweight solution for enabling traceability between source code and documentation.
16+
With a single line in your code, you can:
17+
18+
1. Defining new ``Sphinx-Needs`` - extracted and integrated into the Sphinx build
19+
2. Embedding existing need IDs - extracted for cross-referencing with need items in the documentation
1820

1921
.. grid:: 1 1 2 2
2022
:gutter: 2 2 3 3

0 commit comments

Comments
 (0)