Skip to content

Docs/better docs#130

Merged
jitsedesmet merged 4 commits into
mainfrom
docs/better-docs
May 7, 2026
Merged

Docs/better docs#130
jitsedesmet merged 4 commits into
mainfrom
docs/better-docs

Conversation

@jitsedesmet
Copy link
Copy Markdown
Member

No description provided.

jitsedesmet and others added 3 commits April 30, 2026 12:39
- Fix critical doc bugs: wrong import paths, broken links, typos across
  multiple READMEs and doc files
- Add comprehensive TSDoc/JSDoc to all public exports: engine builders,
  helper functions, expression helpers, algebra exports, test utilities,
  type groupings, and key classes (AstTransformer, AlgebraFactory,
  Canonicalizer, MinimalSparqlParser, CommonIRIs)
- Expand sparse README files for rules-sparql-1-1, rules-sparql-1-2,
  rules-sparql-1-1-adjust, algebra-transformations-1-2, test-utils,
  and chevrotain with exports tables, usage guidance, and cross-links
- Improve design.md with structured sections, Builder Pattern rationale,
  and cross-references
- Expand AST-structure.md with detailed SourceLocation type descriptions
- Add IndirBuilder usage examples and See Also sections to guidelines.md
- Add cross-references between related documentation files
- Add 4 tests for IndirBuilder.merge() to achieve 100% test coverage
  (non-overlapping merge, same-reference merge, override on conflict,
  throw on unresolved conflict)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@jitsedesmet jitsedesmet marked this pull request as ready for review May 6, 2026 09:37
Copy link
Copy Markdown
Member Author

@jitsedesmet jitsedesmet left a comment

Choose a reason for hiding this comment

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

Good start

Comment thread docs/guidelines.md Outdated
Comment thread docs/guidelines.md Outdated
Comment thread docs/guidelines.md Outdated
Comment thread docs/guidelines.md Outdated
Comment thread engines/algebra-sparql-1-1/lib/toAlgebra.ts Outdated
Comment thread engines/generator-sparql-1-2/lib/index.ts Outdated
Comment thread engines/parser-sparql-1-1/lib/Parser.ts Outdated
Comment thread engines/parser-sparql-1-2/lib/Parser.ts Outdated
Comment thread packages/chevrotain/README.md Outdated
Comment thread packages/test-utils/lib/generators/algebraGenerators.ts
@jitsedesmet jitsedesmet merged commit 1873a1b into main May 7, 2026
55 checks passed
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