Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,21 @@ jobs:
bundler-cache: true
working-directory: docs
- name: Build with Jekyll (validation only, no deploy)
# --baseurl "" strips the /claude-memory-files prefix from rendered
# URLs so lychee can resolve them against docs/_site/ (see
# lychee.toml's base setting).
run: bundle exec jekyll build --strict_front_matter --trace --baseurl ""
# Production baseurl is kept so canonical URLs in rendered HTML
# match the live site at riboseinc.github.io/claude-memory-files/.
# Output is written into _lychee_site/claude-memory-files/ so the
# filesystem layout mirrors the URL structure — root-relative
# links like /claude-memory-files/concepts/foo/ then resolve
# against root-dir = docs/_lychee_site without lychee remap.
run: bundle exec jekyll build --strict_front_matter --trace --destination _lychee_site/claude-memory-files
working-directory: docs
env:
JEKYLL_ENV: production

- name: Check links with lychee
uses: lycheeverse/lychee-action@v2
with:
args: --config lychee.toml --root-dir "${{ github.workspace }}/docs/_site" './docs/_site/**/*.html'
args: --config lychee.toml --root-dir "${{ github.workspace }}/docs/_lychee_site" './docs/_lychee_site/**/*.html'
fail: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ node_modules/

# Jekyll docs site build artefacts
docs/_site/
docs/_lychee_site/
docs/vendor/
docs/.bundle/
docs/.jekyll-cache/
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Curated, modular memory and instruction files for [Claude Code](https://claude.com/claude-code), maintained by Ribose for developers across our orgs (`riboseinc/*`, `metanorma/*`, `lutaml/*`, `plurimath/*`, `relaton/*`).

**📖 Documentation site: [riboseinc.github.io/claude-memory-files](https://riboseinc.github.io/claude-memory-files/)** — getting started, concepts (scope rubric, mechanism/data, hooks-deferred rationale), task guides (cherry-pick via curl, slash commands, submitting your own file, customising personal-share, updating installed files), reference (frontmatter schema, file types, validator rules, manifest format, slash commands), and roadmap.

## What this repo is

A flat, cherry-pickable collection of small files that you can drop into your local `~/.claude/` setup individually — **not** a monolithic configuration to adopt wholesale. Each file declares mandatory YAML frontmatter (`name`, `description`, `type`, `scope`, …) and lives under one of five category directories that mirror Claude Code's content surface:
Expand Down
18 changes: 8 additions & 10 deletions lychee.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,14 @@
# but are otherwise live.
accept = ["200..=206", "301", "302", "303", "307", "308", "403", "429"]

# Don't check self-referential absolute URLs to the live site or to the
# repo's main branch — they may not exist yet (this PR may be the one
# creating them). The riboseinc.github.io rule is broadened to all paths
# on the host because validate-docs builds with --baseurl "" so canonical
# URLs lack the /claude-memory-files prefix.
exclude = [
"^https://riboseinc\\.github\\.io/",
"^https://github\\.com/riboseinc/claude-memory-files/tree/main/docs/",
"^https://github\\.com/riboseinc/claude-memory-files/blob/main/docs/",
]
# Self-reference exclusions are no longer needed:
# - The live site at https://riboseinc.github.io/claude-memory-files/ is
# deployed (D3 merged + GH Pages enabled), so canonical URLs resolve.
# - The .adoc files under github.com/.../tree|blob/main/docs/ exist on
# main (D3 merged), so source-file references resolve.
# If a future PR needs to temporarily exclude self-references again (e.g.
# during a docs-site restructure that hasn't deployed yet), re-add them
# here.

# Treat localhost / 127.0.0.1 / 0.0.0.0 references as OK (the Jekyll dev
# server's URLs will appear in the rendered output during local builds).
Expand Down
Loading