Skip to content

Commit ef8d89a

Browse files
committed
fix: add conditional to center images on github
1 parent b3f6ee1 commit ef8d89a

File tree

1 file changed

+216
-0
lines changed

1 file changed

+216
-0
lines changed

samples/contract-compliance-analysis/documentation/technical-documentation.adoc

Lines changed: 216 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,23 +218,71 @@ The prototype is built on a serverless, event-driven architecture that leverages
218218

219219
The following diagrams illustrate the prototype architecture at different levels of detail:
220220

221+
ifdef::env-github[]
222+
++++
223+
<p align="center">
224+
<img src="images/high-level-architecture.png" width="90%" alt="High Level Architecture">
225+
<br>
226+
<em>High Level Architecture</em>
227+
</p>
228+
++++
229+
endif::[]
230+
231+
ifndef::env-github[]
221232
.High Level Architecture
222233
image::high-level-architecture.png[width=90%,align=center]
234+
endif::[]
223235

224236
The core contract analysis workflow processes contracts through validation, preprocessing, classification, evaluation, and risk assessment:
225237

238+
ifdef::env-github[]
239+
++++
240+
<p align="center">
241+
<img src="images/guidelines-compliance-architecture.png" width="90%" alt="Guidelines Compliance Architecture">
242+
<br>
243+
<em>Guidelines Compliance Architecture</em>
244+
</p>
245+
++++
246+
endif::[]
247+
248+
ifndef::env-github[]
226249
.Guidelines Compliance Architecture
227250
image::guidelines-compliance-architecture.png[width=90%,align=center]
251+
endif::[]
228252

229253
The AI-powered import workflow automatically extracts contract types and guidelines from reference contracts:
230254

255+
ifdef::env-github[]
256+
++++
257+
<p align="center">
258+
<img src="images/contract-import-architecture.png" width="90%" alt="Contract Import Architecture">
259+
<br>
260+
<em>Contract Import Architecture</em>
261+
</p>
262+
++++
263+
endif::[]
264+
265+
ifndef::env-github[]
231266
.Contract Import Architecture
232267
image::contract-import-architecture.png[width=90%,align=center]
268+
endif::[]
233269

234270
The optional legislation compliance feature verifies contract clauses against legislation requirements:
235271

272+
ifdef::env-github[]
273+
++++
274+
<p align="center">
275+
<img src="images/legislation-compliance-architecture.png" width="90%" alt="Legislation Compliance Architecture">
276+
<br>
277+
<em>Legislation Compliance Architecture</em>
278+
</p>
279+
++++
280+
endif::[]
281+
282+
ifndef::env-github[]
236283
.Legislation Compliance Architecture
237284
image::legislation-compliance-architecture.png[width=90%,align=center]
285+
endif::[]
238286

239287
==== Amazon Services Description
240288

@@ -398,8 +446,20 @@ The approach to analyze a contract comprises six different steps, in this order:
398446

399447
The six steps comprise the workflow that is orchestrated by AWS Step Functions. Below, a visual representation of a workflow that ran into completion:
400448

449+
ifdef::env-github[]
450+
++++
451+
<p align="center">
452+
<img src="images/guidelines_stepfunctions_workflow.png" width="40%" alt="Contract Processing - Guidelines compliance Workflow">
453+
<br>
454+
<em>Contract Processing - Guidelines compliance Workflow</em>
455+
</p>
456+
++++
457+
endif::[]
458+
459+
ifndef::env-github[]
401460
.Contract Processing - Guidelines compliance Workflow
402461
image::guidelines_stepfunctions_workflow.png[width=40%,align=center]
462+
endif::[]
403463

404464
The following sections detail each one of those six steps.
405465

@@ -534,8 +594,20 @@ When a contract analysis job is started with legislation checking enabled:
534594
- If ALL clauses are compliant, the contract is marked as compliant
535595
5. The overall compliance status is stored in the Jobs table as `legislation_compliant` (boolean)
536596

597+
ifdef::env-github[]
598+
++++
599+
<p align="center">
600+
<img src="images/legislation_stepfunctions_workflow.png" width="40%" alt="Contract Processing - Legislation Compliance Workflow">
601+
<br>
602+
<em>Contract Processing - Legislation Compliance Workflow</em>
603+
</p>
604+
++++
605+
endif::[]
606+
607+
ifndef::env-github[]
537608
.Contract Processing - Legislation Compliance Workflow
538609
image::legislation_stepfunctions_workflow.png[width=40%,align=center]
610+
endif::[]
539611

540612
==== Legislation Management
541613

@@ -583,8 +655,20 @@ The ContractImportWorkflow is a Step Functions state machine with four steps:
583655
- AI-generated evaluation questions
584656
4. *Finalize Import*: Persists the extracted contract type and all guidelines to DynamoDB tables
585657

658+
ifdef::env-github[]
659+
++++
660+
<p align="center">
661+
<img src="images/contract_import_stepfunctions_workflow.png" width="40%" alt="Contract Import Workflow">
662+
<br>
663+
<em>Contract Import Workflow</em>
664+
</p>
665+
++++
666+
endif::[]
667+
668+
ifndef::env-github[]
586669
.Contract Import Workflow
587670
image::contract_import_stepfunctions_workflow.png[width=40%,align=center]
671+
endif::[]
588672

589673
==== How to Use the Import Feature
590674

@@ -724,8 +808,20 @@ The application uses AWS Amplify UI with Amazon Cognito for authentication. User
724808

725809
==== How to analyze a contract
726810

811+
ifdef::env-github[]
812+
++++
813+
<p align="center">
814+
<img src="images/frontend-list-page.png" width="90%" alt="Home Page - Contract Analysis Job List">
815+
<br>
816+
<em>Home Page - Contract Analysis Job List</em>
817+
</p>
818+
++++
819+
endif::[]
820+
821+
ifndef::env-github[]
727822
.Home Page - Contract Analysis Job List
728823
image::frontend-list-page.png[width=90%,align=center]
824+
endif::[]
729825

730826
Once you open the web application in your browser, the home page displays all contract analysis jobs with filtering capabilities by contract type, status, and review requirements. Click the New Analysis button near the top right corner and select a contract file. Supported formats: PDF (.pdf), Word (.doc, .docx), or plain text (.txt).
731827

@@ -737,25 +833,73 @@ The processing will take a couple of minutes. A click to the refresh button disp
737833

738834
Once processing is complete, click on the job to view detailed analysis results:
739835

836+
ifdef::env-github[]
837+
++++
838+
<p align="center">
839+
<img src="images/frontend-contract-page.png" width="90%" alt="Contract Analysis Results - Overview">
840+
<br>
841+
<em>Contract Analysis Results - Overview</em>
842+
</p>
843+
++++
844+
endif::[]
845+
846+
ifndef::env-github[]
740847
.Contract Analysis Results - Overview
741848
image::frontend-contract-page.png[width=90%,align=center]
849+
endif::[]
742850

743851
The contract analysis results page shows a comprehensive overview including compliance assessment, risk distribution, and classification statistics. Each clause is displayed with its compliance status and impact level.
744852

853+
ifdef::env-github[]
854+
++++
855+
<p align="center">
856+
<img src="images/frontend-clause-analysis.png" width="90%" alt="Clause-by-Clause Analysis">
857+
<br>
858+
<em>Clause-by-Clause Analysis</em>
859+
</p>
860+
++++
861+
endif::[]
862+
863+
ifndef::env-github[]
745864
.Clause-by-Clause Analysis
746865
image::frontend-clause-analysis.png[width=90%,align=center]
866+
endif::[]
747867

748868
Detailed clause analysis shows the original clause text, compliance evaluation against guidelines, and AI-generated recommendations. Each clause is color-coded based on its compliance status and risk level.
749869

870+
ifdef::env-github[]
871+
++++
872+
<p align="center">
873+
<img src="images/frontend-risk-assessment.png" width="70%" alt="Risk Assessment Dashboard">
874+
<br>
875+
<em>Risk Assessment Dashboard</em>
876+
</p>
877+
++++
878+
endif::[]
879+
880+
ifndef::env-github[]
750881
.Risk Assessment Dashboard
751882
image::frontend-risk-assessment.png[width=70%,align=center]
883+
endif::[]
752884

753885
The risk assessment view provides visual analytics of contract risks, showing distribution across impact levels and highlighting areas requiring attention.
754886

755887
==== Contract Type Management Workflow
756888

889+
ifdef::env-github[]
890+
++++
891+
<p align="center">
892+
<img src="images/frontend-contract-type-management.png" width="90%" alt="Contract Type Management Interface">
893+
<br>
894+
<em>Contract Type Management Interface</em>
895+
</p>
896+
++++
897+
endif::[]
898+
899+
ifndef::env-github[]
757900
.Contract Type Management Interface
758901
image::frontend-contract-type-management.png[width=90%,align=center]
902+
endif::[]
759903

760904
The application provides a complete interface for managing contract types:
761905

@@ -766,15 +910,39 @@ The application provides a complete interface for managing contract types:
766910
3. Enter contract type name and description
767911
4. Save - the contract type is created and ready for guidelines
768912

913+
ifdef::env-github[]
914+
++++
915+
<p align="center">
916+
<img src="images/frontend-create-new-contract-type.png" width="90%" alt="Create New Contract Type">
917+
<br>
918+
<em>Create New Contract Type</em>
919+
</p>
920+
++++
921+
endif::[]
922+
923+
ifndef::env-github[]
769924
.Create New Contract Type
770925
image::frontend-create-new-contract-type.png[width=90%,align=center]
926+
endif::[]
771927

772928
The contract type creation form captures essential information including name, description, party types, risk thresholds, and language preferences.
773929

774930
*Importing from Reference Contract (AI-Powered):*
775931

932+
ifdef::env-github[]
933+
++++
934+
<p align="center">
935+
<img src="images/frontend-import-contract-type.png" width="90%" alt="Import Contract Type from Reference">
936+
<br>
937+
<em>Import Contract Type from Reference</em>
938+
</p>
939+
++++
940+
endif::[]
941+
942+
ifndef::env-github[]
776943
.Import Contract Type from Reference
777944
image::frontend-import-contract-type.png[width=90%,align=center]
945+
endif::[]
778946

779947
1. Click "Import Contract Type"
780948
2. Paste a reference contract text (e.g., an existing contract that follows the desired structure)
@@ -785,8 +953,20 @@ image::frontend-import-contract-type.png[width=90%,align=center]
785953
- Example clauses
786954
- Evaluation questions
787955
+
956+
ifdef::env-github[]
957+
++++
958+
<p align="center">
959+
<img src="images/frontend-import-contract-type-progress.png" width="90%" alt="Import Progress Indicator">
960+
<br>
961+
<em>Import Progress Indicator</em>
962+
</p>
963+
++++
964+
endif::[]
965+
966+
ifndef::env-github[]
788967
.Import Progress Indicator
789968
image::frontend-import-contract-type-progress.png[width=90%,align=center]
969+
endif::[]
790970

791971
4. Review the extracted data (progress shown during AI analysis)
792972
5. Edit any fields as needed
@@ -799,8 +979,20 @@ image::frontend-import-contract-type-progress.png[width=90%,align=center]
799979

800980
==== Guidelines Management Workflow
801981

982+
ifdef::env-github[]
983+
++++
984+
<p align="center">
985+
<img src="images/frontend-guidelines-management.png" width="90%" alt="Guidelines Management Interface">
986+
<br>
987+
<em>Guidelines Management Interface</em>
988+
</p>
989+
++++
990+
endif::[]
991+
992+
ifndef::env-github[]
802993
.Guidelines Management Interface
803994
image::frontend-guidelines-management.png[width=90%,align=center]
995+
endif::[]
804996

805997
For each contract type, you can manage its guidelines. The guidelines management page displays all guidelines with search and filtering capabilities, showing guideline counts by impact level.
806998

@@ -817,8 +1009,20 @@ For each contract type, you can manage its guidelines. The guidelines management
8171009
5. Review and edit the generated questions
8181010
6. Save the guideline
8191011

1012+
ifdef::env-github[]
1013+
++++
1014+
<p align="center">
1015+
<img src="images/frontend-edit-guideline.png" width="90%" alt="Edit Guideline">
1016+
<br>
1017+
<em>Edit Guideline</em>
1018+
</p>
1019+
++++
1020+
endif::[]
1021+
1022+
ifndef::env-github[]
8201023
.Edit Guideline
8211024
image::frontend-edit-guideline.png[width=90%,align=center]
1025+
endif::[]
8221026

8231027
The guideline editor allows users to modify clause types, standard wording, impact levels, examples, and evaluation questions. The AI-powered "Generate Questions" feature automatically creates evaluation questions from the standard wording.
8241028

@@ -1806,8 +2010,20 @@ This shared model can help relieve the customer's operational burden as AWS oper
18062010

18072011
The customer assumes responsibility and management of the guest operating system (including updates and security patches), other associated application software as well as the configuration of the AWS provided security group firewall. Customers should carefully consider the services they choose as their responsibilities vary depending on the services used, the integration of those services into their IT environment, and applicable laws and regulations. The nature of this shared responsibility also provides the flexibility and customer control that permits the deployment. As shown in the chart below, this differentiation of responsibility is commonly referred to as Security "of" the Cloud versus Security "in" the Cloud.
18082012

2013+
ifdef::env-github[]
2014+
++++
2015+
<p align="center">
2016+
<img src="images/shared_responsibility_model.jpg" width="80%" alt="Shared responsibility model">
2017+
<br>
2018+
<em>Shared responsibility model</em>
2019+
</p>
2020+
++++
2021+
endif::[]
2022+
2023+
ifndef::env-github[]
18092024
.Shared responsibility model
18102025
image::shared_responsibility_model.jpg[width=80%,align=center]
2026+
endif::[]
18112027

18122028
==== Amazon Bedrock
18132029

0 commit comments

Comments
 (0)