Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more links from quick start pages to API docs #188

Open
pchalasani opened this issue Jul 26, 2023 · 2 comments
Open

Add more links from quick start pages to API docs #188

pchalasani opened this issue Jul 26, 2023 · 2 comments
Assignees

Comments

@pchalasani
Copy link
Contributor

pchalasani commented Jul 26, 2023

In the quick-start docs and other places, wherever we refer to a Langroid class, variable or method, we should make it a hyperlink to the code document-page (and section) where it is defined, e.g.

[`DocChatAgent`][langroid.agent.special.doc_chat_agent.DocChatAgent]

in
https://github.com/langroid/langroid/blob/main/docs/quick-start/chat-agent-docs.md#answer-questions-from-a-set-of-urls

@Mohannadcse
Copy link
Collaborator

Mohannadcse commented Aug 7, 2023

for a variable [use_functions_api][langroid.agent.chat_agent.ChatAgentConfig]??

@Mohannadcse Mohannadcse self-assigned this Aug 7, 2023
@pchalasani
Copy link
Contributor Author

We can start with linking classes and method names, then do more granular.

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

No branches or pull requests

2 participants