Skip to content

Add initial MkDocs documentation site#75

Merged
Melmaphother merged 6 commits intoAgentR1:devfrom
0russwest0:add-doc
Mar 23, 2026
Merged

Add initial MkDocs documentation site#75
Melmaphother merged 6 commits intoAgentR1:devfrom
0russwest0:add-doc

Conversation

@0russwest0
Copy link
Collaborator

Summary

This PR adds an initial documentation site for Agent-R1 based on MkDocs. It introduces a lightweight but structured reading path covering setup, core concepts, and the main multi-step agent workflow.

Changes

  • add MkDocs site configuration in mkdocs.yml
  • add documentation entry pages for Home, Getting Started, Core Concepts, and Tutorials
  • add a minimal setup path with installation and quick start guidance
  • add core concept documentation for Step-level MDP and Layered Abstractions
  • add an Agent Task tutorial focused on AgentEnvLoop and ToolEnv
  • update README.md to point users to the new documentation flow
  • add docs/requirements.txt for documentation dependencies
  • add a GitHub Actions workflow to deploy docs

Notes

  • this is an initial lightweight documentation pass focused on the current core Agent-R1 workflow
  • the docs intentionally prioritize onboarding and conceptual clarity over exhaustive API coverage

…etailed sections on getting started, core concepts, and tutorials. Introduce layered abstractions and step-level MDP concepts, and update the mkdocs configuration for improved navigation. Remove outdated Chinese documentation and add requirements for documentation dependencies.
…agent tasks and layered abstractions. Update the support information to reflect the collaboration with the State Key Laboratory of Cognitive Intelligence. Correct minor typographical errors in the step-level MDP documentation.
@Melmaphother
Copy link
Collaborator

Nice work

Copy link
Collaborator

@Melmaphother Melmaphother left a comment

Choose a reason for hiding this comment

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

No problem

@Melmaphother Melmaphother merged commit 7ec8058 into AgentR1:dev Mar 23, 2026
1 check 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.

2 participants