shiva108
1f8b097244
docs(rag): replace mermaid diagram with static image
...
- Removed the inline Mermaid diagram definition for the secure document ingestion pipeline.
- Replaced the diagram with a reference to a pre-rendered image (assets/rec21_secure_ingestion.png).
- Ensures consistent visual representation of the pipeline across different markdown viewers.
- Avoids potential rendering issues or inconsistencies associated with dynamic Mermaid diagrams.
2026-02-03 19:20:35 +01:00
shiva108
4964487bbe
docs(prompt-injection): enhance code block formatting and clarity
...
- Converted generic text code blocks to specific formats like yaml, bash, math, and python.
- Improves syntax highlighting and semantic understanding of examples.
- Replaced several text blocks with Markdown tables for enhanced readability.
- Provides a clearer, more structured presentation for key concepts.
- Removed redundant horizontal rules at the end of the chapter.
2026-01-23 16:46:14 +01:00
shiva108
438742986b
512
2026-01-22 23:16:00 +01:00
shiva108
a092078433
style: Replace page header SVG with half-height PNG image across documentation files.
2026-01-18 17:08:28 +01:00
shiva108
e7c265ed28
update chapter links
2026-01-10 14:28:32 +01:00
shiva108
f2e83e8c2e
Removing code block markdown
2026-01-10 13:59:33 +01:00
shiva108
88faf9acf7
Improving reading prompt examples
2026-01-10 13:43:27 +01:00
shiva108
c17ae53684
Renaming yaml to text
2026-01-10 13:36:55 +01:00
shiva108
bf480c23c6
More centering
2026-01-10 10:45:58 +01:00
shiva108
21c7273e4e
Fixing codeblocks
2026-01-09 16:01:00 +01:00
shiva108
614a216598
Renaming codeblock
2026-01-09 15:54:44 +01:00
shiva108
cc0868acdb
markdown fixes
2026-01-09 15:48:31 +01:00
shiva108
c64efc2051
setting illustration sizes to 75%
2026-01-09 14:28:56 +01:00
shiva108
1af744a3f5
Image rescaling
2026-01-09 14:18:16 +01:00
shiva108
c3d7cb1b0f
Illustrations have been inserted.
2026-01-09 14:03:32 +01:00
shiva108
ccb930d126
chore: fix markdown linting errors for Gold Master release
...
- Fixed MD040 errors in Chapter 14 (added language identifiers to 170 code blocks)
- Fixed MD025 error in Chapter 15 (changed H1 to H3/H4 in example section)
- Added RELEASE_REVIEW_REPORT.md documenting final audit
- Created fix_md040.py automation script for future use
All critical and high-priority linting issues resolved.
Handbook is now ready for v1.0 Gold Master release.
2026-01-07 00:16:08 +01:00
shiva108
114d1abb32
docs: Standardize documentation headings from bolded text to markdown syntax for improved structure and readability.
2025-12-22 15:24:51 +01:00
shiva108
4751e54670
docs: Update spikee command examples to use openai_api target and remove workspace/ prefix from paths.
2025-12-11 23:39:03 +01:00
shiva108
83fcbb384e
refactor: Replace Garak with spikee as the primary LLM testing tool across all relevant documentation.
2025-12-11 17:45:36 +01:00
shiva108
7aa777b98e
feat: Add new visual diagrams and their generation scripts, integrating them into relevant handbook chapters.
2025-12-07 14:46:10 +01:00
shiva108
a479d40a47
feat: Add theoretical foundation, research landscape, and quick reference to the prompt injection chapter and update the banner image.
2025-12-06 23:35:03 +01:00
shiva108
bc40b4d8a5
docs: Add clarifying notes to examples and estimates, update Garak tool GitHub URL, and refine code snippet placeholders.
2025-12-06 22:54:58 +01:00
shiva108
047f604ef9
feat: add ethical and legal considerations, engagement checklists, and chapter conclusions to handbook.
2025-12-06 20:10:28 +01:00
shiva108
4ca1780bc5
docs: remove alt text from page header images in all chapters and field manuals
2025-12-06 19:31:58 +01:00
shiva108
5082cf9624
docs: Update banner image asset reference from banner.svg to page_header.svg across all documentation files.
2025-12-06 18:13:53 +01:00
shiva108
fc1bd60899
refactor: Relocate RAG architecture content, remove markdown fixer script, and apply minor document formatting.
2025-12-06 17:56:27 +01:00
shiva108
c50979a222
fix: Standardize punctuation by replacing em dashes with hyphens and update chapter numbering across handbook chapters.
2025-12-06 10:48:10 +01:00
shiva108
7da2c7708f
chore: Relocate banner.svg to docs/assets and update all image references.
2025-12-05 19:12:02 +01:00
shiva108
eb21b9b95d
feat: Add banner image to all documentation chapters and field manuals.
2025-12-05 18:13:16 +01:00
shiva108
10c8de97cc
feat: Add initial handbook chapters, summary, and chapter extraction script, while removing old chapter outlines.
2025-12-05 07:15:26 +01:00