Skip to content

Commit 4ffc92f

Browse files
committed
docs: correct Java-only language claims across documentation
MethodAtlas now supports Java, C#/.NET, and TypeScript/JavaScript, but multiple high-visibility pages still described it as a Java-only tool. Updated mkdocs.yml site description, landing page hero and feature bullets, for-security-teams guide (intro, column descriptions, tag explanation), apply-tags and apply-tags-from-csv mode descriptions, and data-governance page to reflect all three supported languages accurately.
1 parent 5ea37f1 commit 4ffc92f

6 files changed

Lines changed: 24 additions & 23 deletions

File tree

docs/concepts/data-governance.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ external communication under any configuration:
1212
| Operation | Data involved |
1313
|---|---|
1414
| Source file traversal | File paths and names within the scan root |
15-
| Java parsing (JavaParser) | Test source file content — in memory only |
15+
| Source file parsing (Java, C#, TypeScript) | Test source file content — in memory only |
1616
| Method discovery | Parsed AST nodes — in memory only |
1717
| Content hash computation | SHA-256 of the AST string — no content transmitted |
1818
| CSV / SARIF / plain-text output | Result data written to stdout or a local file |
@@ -37,9 +37,10 @@ provider's inference API. Each request contains exactly:
3737
This list is included to prevent the AI from inventing or omitting
3838
methods; only methods the parser found are classified.
3939

40-
3. **The test class source file** — the full text of one Java source file
41-
from the scan root, used as semantic context for classification. The file
42-
is truncated to the character limit set by [`-ai-max-class-chars`](../cli-reference.md#-ai-max-class-chars)
40+
3. **The test class source file** — the full text of one test source file
41+
(Java, C#, or TypeScript) from the scan root, used as semantic context for
42+
classification. The file is truncated to the character limit set by
43+
[`-ai-max-class-chars`](../cli-reference.md#-ai-max-class-chars)
4344
(default: 40 000 characters) before transmission. The class name and all
4445
method names are always included; if the class body exceeds the limit, the
4546
trailing lines of the file are omitted.
@@ -65,7 +66,7 @@ Nothing else from the project is included.
6566
| Other test files submitted as context | No — each class is submitted independently |
6667
| File paths or directory structure | No — only the class source text and method names are included; the absolute path on disk is not transmitted |
6768

68-
The AI provider receives the text of one Java test class at a time. No
69+
The AI provider receives the text of one test class (Java, C#, or TypeScript) at a time. No
6970
information about the surrounding project structure, the production
7071
implementation, or any other file is included.
7172

docs/concepts/for-security-teams.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Guide for Security Teams
22

3-
MethodAtlas scans a project's Java test source code and produces a structured inventory of test methods that are relevant to security. This guide is written for security managers, compliance officers, and CISOs who receive MethodAtlas output and need to interpret it, act on findings, and incorporate results into audit evidence packages. It does not assume familiarity with Java development or CI/CD tooling.
3+
MethodAtlas scans a project's test source code (Java, C#, or TypeScript/JavaScript) and produces a structured inventory of test methods that are relevant to security. This guide is written for security managers, compliance officers, and CISOs who receive MethodAtlas output and need to interpret it, act on findings, and incorporate results into audit evidence packages. It does not assume familiarity with any specific development technology or CI/CD tooling.
44

55
## When you receive a CSV
66

@@ -14,7 +14,7 @@ For a complete column reference, see [Output Formats](../output-formats.md).
1414

1515
## What MethodAtlas produces
1616

17-
MethodAtlas reads a project's Java test source code and produces a structured
17+
MethodAtlas reads a project's test source code (Java, C#, or TypeScript/JavaScript) and produces a structured
1818
inventory of test methods that are security-relevant — methods written to
1919
verify that the application correctly implements authentication, cryptography,
2020
input validation, access control, and similar security properties.
@@ -30,11 +30,11 @@ the source changes.
3030

3131
| Column | Present when | Meaning |
3232
|---|---|---|
33-
| `fqcn` | Always | Fully qualified class name — the Java package and class that contains this test |
33+
| `fqcn` | Always | Fully qualified class name — the package/namespace and class that contains this test |
3434
| `method` | Always | The name of the test method |
3535
| `loc` | Always | Inclusive line count of the method declaration |
36-
| `tags` | Always | JUnit `@Tag` values declared in source (e.g. `security`, `auth`) |
37-
| `display_name` | Always | Text of the `@DisplayName` annotation declared on the method; empty when the annotation is absent or declares an empty string (`@DisplayName("")`) |
36+
| `tags` | Always | Source-level tag values declared on the test (e.g. `security`, `auth`)`@Tag` in Java, `[Category]`/`[Trait]` in C# |
37+
| `display_name` | Always | Display name declared on the method (e.g. `@DisplayName` in Java, `[Fact(DisplayName=…)]` in C#); empty when absent |
3838
| `content_hash` | `-content-hash` flag | SHA-256 fingerprint of the enclosing class source — enables revision traceability |
3939

4040
### AI enrichment (present when AI classification is enabled)
@@ -104,7 +104,7 @@ measured by the interaction score.
104104

105105
MethodAtlas produces two independent kinds of security labels for each test method:
106106

107-
**Source-level tags** (`tags` column) are labels (`@Tag("security")`, `@Tag("auth")`, etc.) that a developer typed directly into the Java source file. They are factual — they represent what the developer intended when writing the test. They do not change unless a developer edits the source.
107+
**Source-level tags** (`tags` column) are labels that a developer typed directly into the source file — `@Tag("security")` in Java, `[Category("security")]`/`[Trait("Tag", "security")]` in C#. They are factual — they represent what the developer intended when writing the test. They do not change unless a developer edits the source.
108108

109109
**AI classifications** (`ai_security_relevant`, `ai_tags`, `ai_display_name`, `ai_reason` columns) are produced by an AI model that reads the test method body and reasons about what the test actually does. The AI does not rely on the developer's intent; it reads the code.
110110

docs/overrides/home.html

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -186,9 +186,9 @@
186186
<section class="hero">
187187
<h1>MethodAtlas</h1>
188188
<p>
189-
Scan Java test sources (JUnit&nbsp;5, JUnit&nbsp;4, TestNG), build a structured
190-
security test inventory, and enrich results with AI-generated classification &mdash;
191-
without compiling a single class.
189+
Scan test sources across Java (JUnit&nbsp;5, JUnit&nbsp;4, TestNG), C# (xUnit, NUnit, MSTest),
190+
and TypeScript/JavaScript (Jest, Vitest, Mocha); build a structured security test inventory
191+
and enrich results with AI-generated classification &mdash; without compiling a single class.
192192
</p>
193193
<div class="hero-buttons">
194194
<a class="btn-primary" href="installation/">Get started</a>
@@ -207,8 +207,8 @@ <h1>MethodAtlas</h1>
207207
<div>
208208
<strong>Source-level test inventory</strong>
209209
<p>Discovers test methods via lexical parsing &mdash; no compilation required.
210-
Supports JUnit&nbsp;5, JUnit&nbsp;4, and TestNG; framework is detected automatically
211-
from import declarations.</p>
210+
Supports Java (JUnit&nbsp;5, JUnit&nbsp;4, TestNG), C# (xUnit, NUnit, MSTest),
211+
and TypeScript/JavaScript (Jest, Vitest, Mocha); framework detected automatically.</p>
212212
</div>
213213
</li>
214214
<li>
@@ -233,9 +233,8 @@ <h1>MethodAtlas</h1>
233233
<span class="feature-check"></span>
234234
<div>
235235
<strong>Source write-back</strong>
236-
<p>The <code>-apply-tags</code> mode inserts AI-suggested <code>@DisplayName</code>
237-
and <code>@Tag</code> annotations directly into source files using a
238-
lexical-preserving printer.</p>
236+
<p>The <code>-apply-tags</code> mode inserts AI-suggested display names and tags
237+
directly into Java and C# source files using a lexical-preserving printer.</p>
239238
</div>
240239
</li>
241240
<li>

docs/usage-modes/apply-tags-from-csv.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Apply Tags from CSV
22

3-
The `-apply-tags-from-csv <file>` mode applies reviewed annotation decisions back to Java source files. It reads a MethodAtlas CSV that a human has already reviewed and edited, then writes exactly the `@Tag` and `@DisplayName` annotations recorded in that CSV.
3+
The `-apply-tags-from-csv <file>` mode applies reviewed annotation decisions back to source files (Java and C#). It reads a MethodAtlas CSV that a human has already reviewed and edited, then writes the tag and display-name annotations recorded in that CSV.
44

55
## When to use this mode
66

docs/usage-modes/apply-tags.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Source Write-back
22

3-
The `-apply-tags` modifier instructs MethodAtlas to insert AI-generated `@DisplayName` and `@Tag` annotations directly into the scanned `.java` source files, instead of writing a CSV report.
3+
The `-apply-tags` modifier instructs MethodAtlas to insert AI-generated display names and tags directly into the scanned Java (`.java`) and C# (`.cs`) source files, instead of writing a CSV report.
44

55
## When to use this mode
66

mkdocs.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
site_name: MethodAtlas
22
site_description: >-
3-
Scan Java test sources (JUnit 5, JUnit 4, TestNG), build a structured
4-
security test inventory, and enrich results with AI-generated classification.
3+
Scan test sources across Java (JUnit 5, JUnit 4, TestNG), C# (xUnit, NUnit, MSTest),
4+
and TypeScript/JavaScript (Jest, Vitest, Mocha); build a structured security test
5+
inventory and enrich results with AI-generated classification.
56
Built for regulated environments.
67
site_url: https://accenture.github.io/MethodAtlas/
78
repo_url: https://github.com/Accenture/MethodAtlas

0 commit comments

Comments
 (0)