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.

Sign up for GitHub

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

Jump to bottom

Improve documentation for Tasks, Save/Load, BEHAVIOR Tasks and Knowledgebase #795

Merged
merged 10 commits into from
Jul 12, 2024
Merged

Improve documentation for Tasks, Save/Load, BEHAVIOR Tasks and Knowledgebase #795

merged 10 commits into from
Jul 12, 2024

Conversation

ChengshuLi
Copy link
Member

No description provided.

@ChengshuLi ChengshuLi changed the title Docs eric Improve documentation for Tasks, Save/Load, BEHAVIOR Tasks and Knowledgebase Jul 11, 2024
wensi-ai
wensi-ai approved these changes Jul 11, 2024
View reviewed changes
Copy link
Contributor

@wensi-ai wensi-ai left a comment

Choose a reason for hiding this comment

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

lgtm

docs/tutorials/behavior_tasks.md Outdated Show resolved Hide resolved
cremebrule
cremebrule reviewed Jul 12, 2024
View reviewed changes
docs/modules/tasks.md Outdated Show resolved Hide resolved
cremebrule
cremebrule reviewed Jul 12, 2024
View reviewed changes
docs/modules/tasks.md Outdated Show resolved Hide resolved
cremebrule
cremebrule reviewed Jul 12, 2024
View reviewed changes
docs/tutorials/behavior_knowledgebase.md
icon: material/silverware-fork-knife
---

# 🍴 **BEHAVIOR Knowledgebase**
Copy link
Contributor

Choose a reason for hiding this comment

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

In general, it would be really helpful to have a nice overview figure here. Something that visually shows the bridge between Knowledgebase and OG, e.g.: synset on one side, bridge connecting it to the OG object model(s) on the other side, with category in between, etc.

Can discuss with you tomorrow, this can be a separate PR

Copy link
Member Author

Choose a reason for hiding this comment

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

True, completely agreed! This doc still has much room for improvement! I will leave this comment open.

cremebrule
cremebrule approved these changes Jul 12, 2024
View reviewed changes
Copy link
Contributor

@cremebrule cremebrule left a comment

Choose a reason for hiding this comment

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

overall LGTM. A lot of nits, a couple higher level questions.

@cgokmen cgokmen merged commit 36c41ea into og-develop Jul 12, 2024
1 of 14 checks passed
@cgokmen cgokmen deleted the docs-eric branch July 12, 2024 06:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wensi-ai wensi-ai wensi-ai approved these changes

@cremebrule cremebrule cremebrule approved these changes

@cgokmen cgokmen Awaiting requested review from cgokmen

@hang-yin hang-yin Awaiting requested review from hang-yin

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ChengshuLi @cremebrule @wensi-ai @cgokmen