docs: add choose-your-module onboarding guide#651
Conversation
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
- export_to_rdf() returns a string; use export() for file output - format="json-ld" is invalid; correct value is "jsonld" - ParquetExporter/LPGExporter/ArangoAQLExporter take file_path as a required positional arg, not output= / output_dir= kwargs - ArangoAQLExporter().export(graph) was missing file_path entirely, which would raise TypeError at runtime - Remove misleading 'with provenance embedded' comment (no such param)
KaifAhmad1
left a comment
KaifAhmad1
left a comment
There was a problem hiding this comment.
PR #651 — docs: add choose-your-module onboarding guide
Reviewer: @KaifAhmad1 · Author: @Sameer6305 · Status: Approved
Adds a goal-oriented onboarding guide mapping 35+ developer intents to the right module and starting class. Companion changes clean up getting-started.md, add a forward-link in modules.md, and improve the "Get Started" nav order in docs.json.
Strengths
- Quick Reference table covers the full module surface; all 39 class names verified against source
- Tab-per-workflow structure is well-scoped and easy to scan
AgentContextconstructor params match the actual signatureStill Unsure?accordion handles the most common onboarding blockers well- Nav reorder (
getting-startedbeforequickstart) is the correct reading order
Issues
All were in the Export tab — fixed in follow-up commit 9c3f899:
export_to_rdf()doesn't write files; correct method isexport(data, file_path, format=...)format="json-ld"is invalid; accepted values are"jsonld","turtle","rdfxml"ArangoAQLExporter().export(graph)missing requiredfile_path— raisesTypeErrorParquetExporter(…, output_dir=…)andLPGExporter(…, output=…)silently no-op via**options- "With provenance embedded" comment referenced a non-existent parameter — removed
Verdict
Solid addition. Issues were isolated to one code block and are resolved. Merge when ready.
2 participants
Summary
Adds a new onboarding-focused "Choose Your Module" guide to help developers quickly identify the right Semantica modules and workflows for their use case.
Changes
docs/choose-your-module.mddocs.jsongetting-started.mdwith a canonical guide linkmodules.mdGoals
Verification