The Arctos Handbook is the documentation site for the Arctos Collaborative Collection Management Solution. It is a community-maintained resource built with Jekyll and hosted on GitHub Pages.
View the live site: handbook.arctosdb.org
See CONTRIBUTING.md for guidance on adding or editing pages, including how to choose the right collection, fill in front matter, and name files.
To report an error or suggest a change without editing directly, file an issue.
- Ruby 3.2.6 (managed via rbenv recommended)
- Bundler
git clone https://github.com/ArctosDB/documentation-wiki.git
cd documentation-wiki
git checkout gh-pages
bundle installbundle exec jekyll serveThe site will be available at http://127.0.0.1:4000. Jekyll watches for file changes and rebuilds automatically.
If you are working from a fork, build with the preview config to set the correct baseurl:
bundle exec jekyll serve --config _config.yml,_config_preview.yml| Directory | Purpose |
|---|---|
_documentation/ |
Reference documentation for Arctos data tables and fields |
_best_practices/ |
Recommendations for curatorial decisions and workflows |
_how_to/ |
Step-by-step task instructions |
_resources/ |
Tutorials and external guidelines |
_layouts/ |
Jekyll page layouts |
_includes/ |
Reusable HTML partials |
_sass/ |
Stylesheets |
_data/ |
Site data files (navigation, authors) |
_templates/ |
Templates for new content pages |
- Jekyll 3.10
- Bootstrap 3.4.1
- Font Awesome 5 Free
- Deployed via GitHub Actions to GitHub Pages