Docs (xAlisher): Difference between revisions
Eleutherious (talk | contribs) New tool page, source-checked against the project README |
Eleutherious (talk | contribs) Plainer prose: fewer quotes, project claims attributed, glosses folded in |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Infobox tool | {{Infobox tool | ||
| name = Docs (xAlisher) | | name = Docs (xAlisher) | ||
| what = | | what = Searches the Basecamp and Logos docs and blog from inside Basecamp and returns the exact passage with a link | ||
| stage = Prototype | | stage = Prototype | ||
| licence = MIT | | licence = MIT | ||
| Line 10: | Line 10: | ||
| verified_against = README and v0.1.0 | | verified_against = README and v0.1.0 | ||
}} | }} | ||
'''Docs (xAlisher)''' is a [[Basecamp]] module by xAlisher, published as docs-logos (module name docs_logos). It searches the Logos documentation and blog on the device | '''Docs (xAlisher)''' is a [[Basecamp]] module by xAlisher, published as docs-logos (module name docs_logos). It searches the Logos documentation and blog on the device. Its metadata.json lists no dependencies on other Logos modules. | ||
== What it does == | == What it does == | ||
* It runs a keyword search over docs.logos.co and blog.logos.co | * It runs a keyword search on the device over docs.logos.co and blog.logos.co, with no model and no server. | ||
* It ships an offline copy of the docs, so search works as soon as it is installed. | * It ships an offline copy of the docs, so search works as soon as it is installed. | ||
* It opens any result full screen as Markdown, with code blocks, tables, lists and links | * It opens any result full screen as Markdown, with code blocks, tables, lists and links, and its text and code can be copied. | ||
* Blog results carry their publish date, and newer posts win ties. | * Blog results carry their publish date, and newer posts win ties. | ||
* A Fetch now button crawls the docs and blog again and rebuilds the local index. | * A Fetch now button crawls the docs and blog again and rebuilds the local index. The README says this optional step is its only network use. | ||
Stage: Prototype. The README opens with "This is a personal, experimental hobby project. It is not an official Logos product. Not audited." | Stage: Prototype. The README opens with "This is a personal, experimental hobby project. It is not an official Logos product. Not audited." | ||
== Use it == | == Use it == | ||
* | * Signed packages are on the releases page, with builds for Linux (amd64) and macOS (arm64). | ||
* | * The package installs with the Basecamp Package Manager, or with <code>lgpm modules install --file</code> and the package file. | ||
* The package is signed by xAlisher, so it installs without the allow-unsigned option. | * The package is signed by xAlisher, so it installs without the allow-unsigned option. | ||
* The README does not name a Basecamp version. | * The README does not name a Basecamp version. | ||
| Line 29: | Line 29: | ||
== Build it == | == Build it == | ||
* It needs Nix with flakes. | * It needs Nix with flakes. | ||
* <code>nix build .#</code> builds the module | * <code>nix build .#</code> builds the module and <code>nix build .#lgx-portable</code> builds a portable package. | ||
* <code>python3 tools/crawl_index.py</code> rebuilds the search index. It needs the requests and beautifulsoup4 Python packages. | * <code>python3 tools/crawl_index.py</code> rebuilds the search index. It needs the requests and beautifulsoup4 Python packages. | ||
| Line 42: | Line 42: | ||
* [https://github.com/xAlisher/docs-logos docs-logos README], GitHub, last commit 11 August 2026 | * [https://github.com/xAlisher/docs-logos docs-logos README], GitHub, last commit 11 August 2026 | ||
* [https://github.com/xAlisher/docs-logos/blob/main/metadata.json docs-logos metadata.json], GitHub | * [https://github.com/xAlisher/docs-logos/blob/main/metadata.json docs-logos metadata.json], GitHub | ||
* [https://github.com/xAlisher/docs-logos/releases/tag/v0.1.0 docs-logos v0.1.0 release], GitHub | |||
{{Page status|Stub}} | {{Page status|Stub}} | ||
Latest revision as of 23:26, 4 November 2026
Docs (xAlisher)
What it does: Searches the Basecamp and Logos docs and blog from inside Basecamp and returns the exact passage with a link
Stage: Prototype
Licence: MIT
Verified on 4 November 2026 against README and v0.1.0.
Docs (xAlisher) is a Basecamp module by xAlisher, published as docs-logos (module name docs_logos). It searches the Logos documentation and blog on the device. Its metadata.json lists no dependencies on other Logos modules.
What it does
- It runs a keyword search on the device over docs.logos.co and blog.logos.co, with no model and no server.
- It ships an offline copy of the docs, so search works as soon as it is installed.
- It opens any result full screen as Markdown, with code blocks, tables, lists and links, and its text and code can be copied.
- Blog results carry their publish date, and newer posts win ties.
- A Fetch now button crawls the docs and blog again and rebuilds the local index. The README says this optional step is its only network use.
Stage: Prototype. The README opens with "This is a personal, experimental hobby project. It is not an official Logos product. Not audited."
Use it
- Signed packages are on the releases page, with builds for Linux (amd64) and macOS (arm64).
- The package installs with the Basecamp Package Manager, or with
lgpm modules install --fileand the package file. - The package is signed by xAlisher, so it installs without the allow-unsigned option.
- The README does not name a Basecamp version.
Build it
- It needs Nix with flakes.
nix build .#builds the module andnix build .#lgx-portablebuilds a portable package.python3 tools/crawl_index.pyrebuilds the search index. It needs the requests and beautifulsoup4 Python packages.
Releases
Latest tag: v0.1.0, 7 August 2026. The version in metadata.json is 0.1.0.
See also
Sources
- docs-logos README, GitHub, last commit 11 August 2026
- docs-logos metadata.json, GitHub
- docs-logos v0.1.0 release, GitHub
Page status: Stub. Stub · Outline · Usable · Guide · Star. Anyone can improve this page and change its status.