Skip to content

Enhance documentation with detailed examples and explanations - #39

Merged
hzhangxyz merged 23 commits into
mainfrom
copilot/improve-documentation-details
Nov 26, 2025
Merged

Enhance documentation with detailed examples and explanations#39
hzhangxyz merged 23 commits into
mainfrom
copilot/improve-documentation-details

Conversation

Copilot AI commented Nov 26, 2025

Copy link
Copy Markdown
Contributor

Documentation needed more comprehensive coverage. Added practical examples, usage patterns, and improved explanations across all docs.

Changes

README.md

  • Added documentation link to https://ustc-knowledgecomputinglab.github.io/ds

Getting Started

  • installation.md: Browser usage, virtual env setup, CMake integration, troubleshooting section
  • quickstart.md: Common patterns section, output explanation

Concepts

  • terms.md: Scoped grounding explanation, type checking examples, logical expression building
  • rules.md: Compact rule format, axiom schemas table, manual inference steps
  • search.md: Forward-chaining explanation, buffer size tips, progress monitoring examples

API Reference

  • python.md/typescript.md/cpp.md: Complete working examples, method/operator reference tables, memory management notes (C++)

Examples

  • basic.md: Chained inference, variable unification, result collection patterns

Example Addition

# docs now include practical patterns like:
search = apyds.Search()
search.add("(parent `X `Y) (ancestor `X `Y)")
search.add("(ancestor `X `Y) (parent `Y `Z) (ancestor `X `Z)")
search.add("(parent a b)")
search.add("(parent b c)")

# Run until convergence
while search.execute(lambda r: print(f"Derived: {r}") or False) > 0:
    pass
Original prompt

This section details on the original issue you should resolve

<issue_title>documentation需要更多的完善</issue_title>
<issue_description></issue_description>

<agent_instructions>在docs下的markdown, 可以有更详细的介绍, 请查阅这些docs, 以及README, 以及tests下的例子们, 进一步完善文档. 另外, 记得在README中加入文档的链接.</agent_instructions>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits November 26, 2025 10:32
Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>
Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation with detailed information Enhance documentation with detailed examples and explanations Nov 26, 2025
Copilot AI requested a review from hzhangxyz November 26, 2025 10:37
@hzhangxyz
hzhangxyz marked this pull request as ready for review November 26, 2025 10:39
@hzhangxyz
hzhangxyz merged commit 2fd1669 into main Nov 26, 2025
51 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.

documentation需要更多的完善

2 participants