Skip to content

Add HexDocs guides and slim the README - #26

Open
twist900 wants to merge 1 commit into
mainfrom
docs/hexdocs-guides
Open

twist900 wants to merge 1 commit into
mainfrom
docs/hexdocs-guides

Conversation

@twist900

Copy link
Copy Markdown
Collaborator

Summary

  • Add ExDoc-backed guides/ covering getting started, core concepts, how-tos (agents, checkpointing, HITL, streaming, multi-agent, etc.), and a LangGraph → LangEx concept map
  • Slim the README to a short pitch + install + deep links into HexDocs
  • Wire guides into mix.exs extras / groups and include them in the Hex package; link key guides from the LangEx moduledoc

Test plan

  • mix docs generates without new guide-related warnings; open doc/getting_started.html and a few how-to pages
  • Confirm HexDocs sidebar groups: Guides / Concepts / How-to
  • Skim README for a clear entry point that still shows a working tool-calling snippet
  • Spot-check that README HexDocs links match guide basenames (introduction.html, getting_started.html, …)

Made with Cursor

Move the deep how-tos into ExDoc-backed guides so newcomers get a short pitch
on GitHub and full journeys (getting started, concepts, LangGraph map) on HexDocs.

Co-authored-by: Cursor <cursoragent@cursor.com>
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.

1 participant