The Ash Framework homepage and documentation site.
Go to file
dependabot[bot] 99172d72ad
chore(deps): bump phoenix from 1.7.11 to 1.7.12 (#138)
Bumps [phoenix](https://github.com/phoenixframework/phoenix) from 1.7.11 to 1.7.12.
- [Release notes](https://github.com/phoenixframework/phoenix/releases)
- [Changelog](https://github.com/phoenixframework/phoenix/blob/main/CHANGELOG.md)
- [Commits](https://github.com/phoenixframework/phoenix/compare/v1.7.11...v1.7.12)

---
updated-dependencies:
- dependency-name: phoenix
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-04-16 11:59:03 +01:00
.github chore: enable dependabot for mix dependencies. 2024-04-11 09:29:57 +12:00
.vscode fix: clicking on search result closes 2022-09-19 17:14:15 -04:00
assets improvement: upgrade to 3.0 2024-04-02 20:24:23 -04:00
config improvement: support ash-hq.com domain 2024-04-11 10:01:04 -04:00
lib fix: don't pass tiemout while importing 2024-04-04 21:09:29 -04:00
priv chore: fix credo 2024-04-02 22:08:51 -04:00
rel improvement: disable FLAME for now 2023-12-07 12:29:55 -05:00
scripts improvement: rewrite package search and storage to use sqlite 2023-10-12 18:08:34 -04:00
test chore: fix credo 2024-04-02 22:08:51 -04:00
.check.exs chore: fix credo 2024-04-02 22:08:51 -04:00
.credo.exs improvement: get a build set up 2022-08-06 19:22:58 -04:00
.dockerignore WIP 2022-03-31 17:29:23 -04:00
.formatter.exs chore: format 2024-04-02 20:55:34 -04:00
.gitignore improvement: rewrite package search and storage to use sqlite 2023-10-12 18:08:34 -04:00
.tool-versions improvement: add group-flow logo 2023-07-21 12:14:50 -04:00
CHANGELOG.md chore: fix CI 2022-11-16 14:50:32 -05:00
Dockerfile chore: update now that we aren't using litefs 2024-01-12 14:24:22 -05:00
LICENSE.md create LICENSE.md (#51) 2022-11-13 11:52:54 -05:00
README.md Update README.md 2023-02-04 07:44:51 -05:00
dialyzer.ignore_warnings chore: fix build 2022-12-27 14:11:08 -05:00
fly.toml improvement: remove sqlite 2024-01-12 12:43:25 -05:00
litefs.yml chore: updates, add new libraries 2023-12-19 12:21:42 -05:00
livebook.livemd improvement: fix item paths, make sidebar much friendlier 2022-08-04 13:14:58 -04:00
mix.exs chore: fix ash dep 2024-04-02 22:13:24 -04:00
mix.lock chore(deps): bump phoenix from 1.7.11 to 1.7.12 (#138) 2024-04-16 11:59:03 +01:00

README.md

AshHq

Getting Started

  1. Fork and clone this repository.
  2. Set up the project by running mix do deps.get, deps.compile, setup
  3. Run mix import to import the latest dependencies from hex (this may take a while)
  4. Install the frontend assets by running npm i --prefix assets.
  5. Run the server with iex -S mix phx.server
  6. Open http://localhost:4000

Note to linux users: You will need the following packages (or their equivalents) to compile successfully: erlang-dev erlang-parsetools erlang-os-mon erlang-xmerl erlang-tools

A Bit of History

The docs are not static content like you would typically see for documentation. They are all stored in a database, because they can all be full-text searched using postgres. Eventually it would make sense to serve the individual doc pages from a CDN or something like that. The interesting pages in that regard is the Docs page. We do quite a bit of work to make sure that we are only loading the html that will be served for the exact document we are seeing.

The magic of search is done via AshHq.Docs.Extensions.Search, which modifies resources to make them full text searchable using postgres, amongst other things. See lib/ash_hq/docs/extensions/search/transformers/add_search_structure.ex for more.

There is also a usage of Ash.Flow for searching, which can be found in lib/ash_hq/docs/search/search.ex. It is actually a bit un-ideal, as the better thing to do would be to use a postgres UNION. There are ways to do that with Ash by extracting the resource queries and then making a union, but it was much easier to just put a search action in a flow. Eventually, Ash will support unions.