Skip to content

Improve LLM-based documentation exploration for Actionbase #15

@em3s

Description

@em3s

Background

Actionbase aims to be easier to approach for both contributors and users.

The Actionbase documentation is publicly available at https://actionbase.io/. As more LLM tools can fetch and read content directly from the web, Actionbase should support workflows that go beyond manual download and upload.

Note

While preparing Actionbase for its open source release, the documentation was revised to be clearer and more consistent. LLM tools were used to review the written content.

The workflow was:

  • Bundle documentation as a zip file
  • Upload it to an LLM tool
  • Ask for review or assistance

This approach works, but it does not scale well. A more flexible and LLM-friendly documentation exploration workflow is needed.

Current Approach

As a first step, Actionbase adopted llms.txt (https://github.com/delucis/starlight-llms-txt) and provides guidance at https://actionbase.io/llms-txt/.

This has established a basic integration point for LLM-based documentation access, but there is still room for improvement.

Goal

The goal of this issue is not to decide on a single direction upfront, but to explore multiple approaches through experimentation and iteration.

Based on these explorations, we would like to evaluate what works best for Actionbase and then discuss whether to:

  • improve the existing https://actionbase.io/llms-txt/ page, or
  • replace it with a clearer and more structured guide for LLM-based documentation exploration.

Incomplete proposals are welcome, including small experiments or draft-level pull requests.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedCommunity contributions are welcome

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions