elixir.menu/agent-site.json at main · optimumBA/elixir.menu · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
{
  "origin": "https://elixir.menu",
  "name": "elixir.menu",
  "description": "Tools and recommendations for Elixir applications.",
  "contact": "consulting@optimum.ba",
  "siteType": "content",
  "about": [
    "elixir.menu is an independent editorial guide by Optimum Tech for choosing tools for Elixir applications. Start with an application type, explore a Phoenix and LiveView web stack, and choose libraries by feature. Recommendations describe their reasons and limits so that a reader can make a decision in the context of a particular application.",
    "The guide is not a framework or an installer. The complete set of optional libraries has not been tested as one integrated distribution. Canonical recommendation data and authored content generate the website and its Markdown and JSON exports together. Linked library repositories and documentation own the details of those projects."
  ],
  "whenToUse": "For Elixir tool selection, first fetch https://elixir.menu/agents.md with an available HTTP or text-retrieval tool. Then read https://elixir.menu/llms.txt and only the relevant Markdown or JSON guides. Browser interaction is unnecessary for reference lookup when direct retrieval is available. If only a browser is available, open the same guide URLs. Public HTML pages also support Accept: text/markdown. Use existing project decisions and installed-version documentation first.",
  "organization": {
    "@type": "Organization",
    "@id": "https://optimum.ba/#organization",
    "name": "Optimum Tech",
    "legalName": "Optimum Tech, LLC",
    "description": "Software development and product consulting. Optimum Tech helps businesses decide what to build, develop the software, and put it to work.",
    "url": "https://optimum.ba/",
    "address": {
      "@type": "PostalAddress",
      "streetAddress": "1207 Delaware Ave #2578",
      "addressLocality": "Wilmington",
      "addressRegion": "DE",
      "postalCode": "19806",
      "addressCountry": "US"
    },
    "contactPoint": {
      "@type": "ContactPoint",
      "contactType": "consulting",
      "email": "consulting@optimum.ba"
    },
    "sameAs": [
      "https://github.com/optimumBA",
      "https://www.linkedin.com/company/optimum-tech-llc/",
      "https://x.com/optimumBA"
    ]
  },
  "agentEntry": {
    "title": "Using a coding agent?",
    "summary": "Fetch these references with an available HTTP or text-retrieval tool, then apply them to the application’s requirements.",
    "label": "Start here: agent instructions",
    "prompt": "Use https://elixir.menu/agents.md as the starting point. Fetch the relevant Markdown or JSON guides directly if your tools support it, preserve this project’s decisions, and recommend only what its requirements need.",
    "steps": [
      {
        "title": "Fetch the guide directly",
        "body": "Use an available HTTP client, web-fetch or text-retrieval tool to GET https://elixir.menu/agents.md, then https://elixir.menu/llms.txt. This is a content reference: no API key, account, installer, MCP connection or browser clicks are needed to read these exports. If your environment only offers a browser, open the same URLs there."
      },
      {
        "title": "Read only the relevant resources",
        "body": "Start with app-guide.md for application paths and shared checks. Use runtime.md for OTP, concurrency and performance; optional.md for libraries by use case; stack.md for the Phoenix web stack; setup.md only for a new Phoenix + LiveView application with PostgreSQL. Matching JSON files carry structured data. Do not read the entire homepage or install the entire catalogue by default."
      },
      {
        "title": "Apply the project’s requirements",
        "body": "Read README.md, mix.exs, mix.lock and runtime pins before proposing changes. Preserve the existing architecture and maintained workflow. Choose tools for actual needs, explain their integration work and verify details against the installed-version documentation linked by each entry."
      },
      {
        "title": "Verify the resulting application",
        "body": "Run the project’s formatting, compilation and relevant behavior checks. For declared module boundaries, configure Boundary and make its warnings fail CI. State what you verified and what remains untested. These recommendations do not establish compatibility, performance or production readiness for your application."
      }
    ]
  }
}