Skip to content

[elixir] Set up HexDocs and add usage guides - #4633

Open
nicolazar wants to merge 1 commit into
apache:mainfrom
nicolazar:feat/elixir-hexdocs
Open

nicolazar wants to merge 1 commit into
apache:mainfrom
nicolazar:feat/elixir-hexdocs

Conversation

@nicolazar

Copy link
Copy Markdown
Contributor

Purpose

Linked issue: close apache/fluss-rust#465

Brief change log

This PR sets up hexdocs and adds basic usage rules.

  • mix.exs: README as the landing page, modules grouped by area, and source links into the monorepo path.
  • Guides: log tables and data types (Fluss type, schema atom and Elixir value, with conversions to standard library types).
  • Ignore the generated doc/ directory.

Configure ExDoc for the Elixir client and add the first guides.

- mix.exs: README as the landing page, modules grouped by area, and
  source links into the monorepo path.
- Guides: log tables (create, write, and a GenServer consumer) and data
  types (Fluss type, schema atom and Elixir value, with conversions to
  standard library types).
- Fluss.Admin: document that create/drop calls ignore an existing or
  missing database or table by default, and that drop_database doesn't
  cascade.
- Ignore the generated doc/ directory.
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.

[elixir] Documentation

1 participant