Skip to content

Revise various documentation inconsistencies and clarification#804

Merged
jviotti merged 2 commits intomainfrom
doc-fixes
Apr 2, 2026
Merged

Revise various documentation inconsistencies and clarification#804
jviotti merged 2 commits intomainfrom
doc-fixes

Conversation

@jviotti
Copy link
Copy Markdown
Member

@jviotti jviotti commented Apr 2, 2026

Signed-off-by: Juan Cruz Viotti jv@jviotti.com

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 2 files

@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Apr 2, 2026

🤖 Augment PR Summary

Summary: This PR tightens up and expands documentation around enterprise features and configuration behavior.

Changes:

  • Clarifies the Enterprise edition description and adds a dedicated Standard Library section in docs/commercial.md.
  • Updates configuration docs to use include (singular) for in-place collection inclusion and renames the corresponding section.
  • Expands the resolve documentation with an Enterprise-focused example and a note about standard-library availability.
  • Simplifies the extends example list to reduce references to non-essential built-in collections.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review completed. 2 suggestions posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

schemas for commonly used standards and specifications such as IETF URIs, email
addresses, JSON Pointers, HTTP problem details, and IEEE POSIX paths, among
others. To use it, add `@sourcemeta/std/v0` to the
[`extends`](configuration.md#extends-optional) property of your configuration
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The configuration.md#extends-optional anchor doesn’t appear to exist (the heading in docs/configuration.md is ## Extends, which typically renders as #extends), so this link may be broken for readers.

Severity: low

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

[GeoJSON](https://geojson.org) and has various references to its latest
official URL: `https://geojson.org/schema/GeoJSON.json`. Instead of depending
on an external resource outside your control, you can configure the instance to
extend from the `@sourcemeta/std` built-in collection and rephrase the
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section (and the note below) refers to the standard library as @sourcemeta/std, but the actual built-in collection identifier appears to be versioned (e.g., @sourcemeta/std/v0); using the unversioned form here may cause users to configure extends incorrectly.

Severity: medium

Other Locations
  • docs/configuration.md:210

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

Copy link
Copy Markdown
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Benchmark Index (community)

Details
Benchmark suite Current: 35fcbeb Previous: 1d6a37b Ratio
Add one schema (0 existing) 19 ms 19 ms 1
Add one schema (100 existing) 23 ms 23 ms 1
Add one schema (1000 existing) 79 ms 73 ms 1.08
Add one schema (10000 existing) 670 ms 643 ms 1.04
Update one schema (1 existing) 16 ms 16 ms 1
Update one schema (101 existing) 25 ms 23 ms 1.09
Update one schema (1001 existing) 83 ms 77 ms 1.08
Update one schema (10001 existing) 895 ms 638 ms 1.40
Cached rebuild (1 existing) 9 ms 9 ms 1
Cached rebuild (101 existing) 11 ms 11 ms 1
Cached rebuild (1001 existing) 33 ms 30 ms 1.10
Cached rebuild (10001 existing) 276 ms 247 ms 1.12
Index 100 schemas 130 ms 125 ms 1.04
Index 1000 schemas 1005 ms 1077 ms 0.93
Index 10000 schemas 13030 ms 13066 ms 1.00

This comment was automatically generated by workflow using github-action-benchmark.

Copy link
Copy Markdown
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Benchmark Index (enterprise)

Details
Benchmark suite Current: 35fcbeb Previous: 1d6a37b Ratio
Add one schema (0 existing) 20 ms 19 ms 1.05
Add one schema (100 existing) 24 ms 24 ms 1
Add one schema (1000 existing) 72 ms 72 ms 1
Add one schema (10000 existing) 582 ms 753 ms 0.77
Update one schema (1 existing) 18 ms 18 ms 1
Update one schema (101 existing) 24 ms 24 ms 1
Update one schema (1001 existing) 70 ms 76 ms 0.92
Update one schema (10001 existing) 598 ms 620 ms 0.96
Cached rebuild (1 existing) 9 ms 9 ms 1
Cached rebuild (101 existing) 11 ms 12 ms 0.92
Cached rebuild (1001 existing) 31 ms 31 ms 1
Cached rebuild (10001 existing) 243 ms 276 ms 0.88
Index 100 schemas 111 ms 128 ms 0.87
Index 1000 schemas 1053 ms 1082 ms 0.97
Index 10000 schemas 13687 ms 14264 ms 0.96

This comment was automatically generated by workflow using github-action-benchmark.

jviotti added 2 commits April 2, 2026 12:59
Signed-off-by: Juan Cruz Viotti <jv@jviotti.com>
Signed-off-by: Juan Cruz Viotti <jv@jviotti.com>
@jviotti jviotti merged commit aca182e into main Apr 2, 2026
5 checks passed
@jviotti jviotti deleted the doc-fixes branch April 2, 2026 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant