Merged
Conversation
Adds a 15-file documentation set under docs/ covering: - Getting started, configuration - Core concepts: Index, Repository, Document, Collection - Search, Import, Transport layer - Events, Plugins, CLI, Errors - Extensions overview
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a full documentation set under
docs/as markdown files, organized by topic:README.md,getting-started.md,configuration.mdindex.md,repository.md,document.md,collection.mdsearch.md,import.md,transport.mdevents.md,plugins.md,cli.md,errors.mdextensions.md(links to per-gem docs in sibling repos)Each extension gem (
esse-active_record,esse-rails,esse-sequel,esse-async_indexing,esse-hooks,esse-jbuilder,esse-kaminari,esse-pagy) ships its owndocs/in its repo; the main gem'sextensions.mdcross-links to them.Test plan
docs/README.mdas a navigation entry pointgetting-started.mdmatch current APIextensions.mdresolve against sibling repo paths