-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
export/html: DIFF: add a legend to explain the most basic query rules
- Loading branch information
Showing
2 changed files
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<div> | ||
<h5>Legend</h5> | ||
<p>The Diff/Changelog feature only works when StrictDoc is run against a directory which is a Git repository.</p> | ||
<p>The left-hand-side (LHS) and the right-hand-side (RHS) revisions must be valid Git revisions.</p> | ||
<p>Examples of valid revisions: a Git branch or a Git commit. Examples: `main`, `origin/main`, `63fd784`. | ||
<p>The StrictDoc's custom revision `HEAD+` can be used to indicate "the current branch + all uncommitted changes".</p> | ||
<p>The Diff/Changelog query is shareable via a URL. Example: <a href="http://127.0.0.1:5111/diff?left_revision=HEAD%5E&right_revision=HEAD&tab=diff">This link</a> opens a diff between the last commit and the last but one commit.</p> | ||
|
||
<p>The StrictDoc diff algorithm compares documentation trees (left-hand side, LHS, and right-hand side, RHS) based on these principles:</p> | ||
|
||
<ul> | ||
<li> | ||
Optimal comparison of document contents is achieved using automatically-generated Machine Identifiers (MID). This ensures the best match. | ||
</li> | ||
<li> | ||
If document nodes, such as Sections or Requirements, lack MIDs, they are matched using their UID field. Matching quality with UIDs is comparable to that with MIDs, provided all nodes have UIDs. | ||
</li> | ||
<li> | ||
In cases where document nodes do not have either MID or UID, matching generally isn't performed or is very limited to the most basic cases. Changes to nodes lacking MID/UID are recorded as separate events: "node removed" for LHS and "node added" for RHS. | ||
</li> | ||
</ul> | ||
</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters