Skip to content

[FEATURE] Add a DeepWiki link in README #4

@hellomypastor

Description

@hellomypastor

Feature Description

Add a DeepWiki link generated by the project owner and include it in the README for quick navigation.

Use Case

As a developer, I want a single DeepWiki entry link in the README so that newcomers can quickly find curated, up-to-date project knowledge.

Proposed Solution

Owner generates a DeepWiki link for AssistantAgent and we add it to the README’s reference/links section.

Alternatives Considered

  • Keeping only the GitHub README links (less discoverability for deeper docs).
  • Linking to ad-hoc docs scattered in issues or PRs (harder to find).

Additional Context

  • Would live alongside the existing documentation links in README.

Implementation Notes (optional)

  • Affects: README.md (possibly README_zh.md).
  • After the owner provides the DeepWiki link, we add it under Reference Documentation.
  • Happy to open a PR to insert the link once provided.

Priority

  • Critical - Blocking my use case
  • High - Significantly improves workflow
  • Medium - Nice to have
  • Low - Minor improvement

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions