Skip to content

Commit e9908ec

Browse files
committed
chore: Merge al-folio v1.0 upstream updates
2 parents 40311b8 + 08bc679 commit e9908ec

286 files changed

Lines changed: 3538 additions & 60154 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# al-folio Bootstrap
2+
3+
Use this skill when a user asks an agent to create, configure, or personalize a new al-folio v1.x website.
4+
5+
## Workflow
6+
7+
1. Read `AGENTS.md` and `docs/BOUNDARIES.md` before editing.
8+
2. Keep the starter small: customize `_config.yml`, `_data`, content collections, and site assets first.
9+
3. Leave runtime behavior in plugin repos. Do not copy plugin-owned layouts, includes, Sass, JavaScript, or assets into the starter unless the user intentionally wants a local override.
10+
4. For local visual/content customization, prefer:
11+
- `_config.yml` feature flags and site metadata
12+
- `_data/*.yml`
13+
- `_pages`, `_posts`, `_projects`, `_news`, `_teachings`, `_bibliography`
14+
- local `_includes`, `_layouts`, and `_sass` overrides only when config/content cannot express the change
15+
5. Run validation before handing work back:
16+
17+
```bash
18+
npm ci
19+
npm run lint:prettier
20+
bundle exec al-folio upgrade audit --no-fail
21+
bundle exec jekyll build --baseurl /al-folio
22+
```
23+
24+
## Routing
25+
26+
- Starter wiring/docs/examples/tests: edit `al-folio`.
27+
- Shared layouts/includes/assets: use `al_folio_core`.
28+
- CV rendering: use `al_folio_cv`.
29+
- Distill runtime: use `al_folio_distill`.
30+
- Search/icons/math/comments/analytics/citations/external posts/newsletter/charts/images: use the owning `al-*` plugin repo.
31+
32+
## Handoff
33+
34+
Summarize changed files, validation results, and any local overrides created.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# al-folio v1 Migration
2+
3+
Use this skill when a user asks an agent to migrate an existing customized al-folio fork to v1.x.
4+
5+
## Workflow
6+
7+
1. Work in a disposable branch, fork, or clone. Do not overwrite the user's original site.
8+
2. Start from the v1 starter contract, then bring over site-owned files:
9+
- `_config.yml` values
10+
- `_data`
11+
- `_bibliography`
12+
- content collections
13+
- site assets
14+
- intentional local `_includes`, `_layouts`, and `_sass` overrides
15+
3. Keep v1 plugin wiring from the starter:
16+
- `theme: al_folio_core`
17+
- bundled `al_*` and `al_folio_*` gems in `Gemfile`
18+
- bundled plugin entries in `_config.yml`
19+
4. Remove stale copied runtime files now owned by plugins unless they are intentional overrides.
20+
5. Run upgrade checks:
21+
22+
```bash
23+
bundle exec al-folio upgrade audit --no-fail
24+
bundle exec al-folio upgrade overrides audit
25+
```
26+
27+
6. For each stale or unacknowledged override:
28+
29+
```bash
30+
bundle exec al-folio upgrade overrides diff LOCAL_PATH
31+
bundle exec al-folio upgrade overrides accept LOCAL_PATH
32+
```
33+
34+
7. Build and inspect key pages: home, CV, publications, repositories, projects, posts, and any custom routes.
35+
36+
## Migration Notes
37+
38+
Commit `.al-folio-overrides.yml` when the site intentionally keeps local overrides. It records the upstream plugin file checksum last reviewed so future gem updates can flag drift explicitly.
39+
40+
## Handoff
41+
42+
Report removed stale runtime files, retained local overrides, unresolved visual differences, and exact validation commands.

.claude/skills

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../.agents/skills

.codex/skills

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../.agents/skills

.gemini/settings.json

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@
66
".github/agents/customize.agent.md",
77
".github/agents/docs.agent.md",
88
".github/instructions/**/*.md",
9-
"CUSTOMIZE.md",
10-
"INSTALL.md",
11-
"TROUBLESHOOTING.md",
12-
"QUICKSTART.md"
9+
"docs/README.md",
10+
"docs/CUSTOMIZE.md",
11+
"docs/INSTALL.md",
12+
"docs/TROUBLESHOOTING.md",
13+
"docs/QUICKSTART.md",
14+
"docs/BOUNDARIES.md"
1315
]
1416
}
1517
}

.github/GIT_WORKFLOW.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ All commit messages should follow this format:
2626
```
2727
feat: Add dark mode toggle button to header
2828
fix: Correct baseurl in project site configuration
29-
docs: Update INSTALL.md with Docker troubleshooting
29+
docs: Update docs/INSTALL.md with Docker troubleshooting
3030
style: Format all Liquid templates with Prettier
3131
config: Enable blog section in _config.yml
3232
chore: Update Jekyll dependencies with bundle update --all

.github/ISSUE_TEMPLATE/1_bug_report.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ body:
88
Before you go any further. Is this really a **🐛 bug**?
99
1010
If it's a question about how al-folio works, have a look at our [documentation](https://github.com/alshedivat/al-folio/blob/main/README.md),
11-
[frequently asked questions](https://github.com/alshedivat/al-folio/blob/main/FAQ.md),
11+
[frequently asked questions](https://github.com/alshedivat/al-folio/blob/main/docs/FAQ.md),
1212
[past questions](https://github.com/alshedivat/al-folio/discussions/categories/q-a),
1313
or [ask a question](https://github.com/alshedivat/al-folio/discussions/new?category=q-a).
1414
@@ -20,7 +20,7 @@ body:
2020
Please check if somebody else has already filed the same issue.
2121
If you find a similar issue, please add a 👍 reaction or comment on the original post.
2222
options:
23-
- label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/main/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my issue.
23+
- label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/main/docs/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my issue.
2424
required: true
2525
- label: Yes, I have checked that this issue isn't already filed.
2626
required: true

.github/ISSUE_TEMPLATE/2_feature_request.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ body:
88
Before you go any further, are you sure that this feature is not already implemented?
99
1010
If it's a question about how al-folio works, have a look at our [documentation](https://github.com/alshedivat/al-folio/blob/main/README.md),
11-
[frequently asked questions](https://github.com/alshedivat/al-folio/blob/main/FAQ.md),
11+
[frequently asked questions](https://github.com/alshedivat/al-folio/blob/main/docs/FAQ.md),
1212
[past questions](https://github.com/alshedivat/al-folio/discussions/categories/q-a),
1313
or [ask a question](https://github.com/alshedivat/al-folio/discussions/new?category=q-a).
1414
@@ -20,7 +20,7 @@ body:
2020
Please check if somebody else has already filed the same 🚀 feature request.
2121
If you find a similar feature request, please add a 👍 reaction or comment on the original post.
2222
options:
23-
- label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/main/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my feature request.
23+
- label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/main/docs/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my feature request.
2424
required: true
2525
- label: Yes, I have checked that this feature request isn't already filed.
2626
required: true
Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
name: "🔌 Plugin feature proposal"
2+
description: Propose a plugin to be listed (featured) or bundled in al-folio.
3+
labels: ["needs triage", "plugin-ecosystem"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: >
8+
Use this template to propose adding a plugin to the `al-folio` ecosystem catalog.
9+
Featuring and bundling are separate decisions.
10+
11+
- type: checkboxes
12+
id: requirements
13+
attributes:
14+
label: Proposal checklist
15+
options:
16+
- label: I confirmed this plugin is not already listed in `_data/featured_plugins.yml`.
17+
required: true
18+
- label: I understand that featuring does not automatically mean bundling.
19+
required: true
20+
21+
- type: input
22+
id: plugin_name
23+
attributes:
24+
label: Plugin name
25+
description: Human-readable plugin name.
26+
placeholder: al_folio_example
27+
validations:
28+
required: true
29+
30+
- type: input
31+
id: repo_url
32+
attributes:
33+
label: Repository URL
34+
description: Public repository URL for the plugin.
35+
placeholder: https://github.com/your-org/al-folio-example
36+
validations:
37+
required: true
38+
39+
- type: input
40+
id: gem_name
41+
attributes:
42+
label: Gem name
43+
description: Name published on RubyGems.
44+
placeholder: al_folio_example
45+
validations:
46+
required: true
47+
48+
- type: input
49+
id: plugin_id
50+
attributes:
51+
label: Jekyll plugin ID
52+
description: Plugin id used in `_config.yml` plugins list.
53+
placeholder: al_folio_example
54+
validations:
55+
required: true
56+
57+
- type: dropdown
58+
id: plugin_scope
59+
attributes:
60+
label: Plugin scope
61+
description: Does this plugin depend on al-folio-specific runtime contracts?
62+
options:
63+
- Theme-coupled (al-folio-specific)
64+
- Reusable (works outside al-folio)
65+
validations:
66+
required: true
67+
68+
- type: dropdown
69+
id: requested_track
70+
attributes:
71+
label: Requested track
72+
description: Which listing track are you proposing?
73+
options:
74+
- Featured-only
75+
- Bundled in starter
76+
validations:
77+
required: true
78+
79+
- type: input
80+
id: compatibility
81+
attributes:
82+
label: Compatibility range
83+
description: al-folio versions supported by this plugin.
84+
placeholder: "al_folio_min: 1.0.0, al_folio_max: 1.x"
85+
validations:
86+
required: true
87+
88+
- type: input
89+
id: demo_path
90+
attributes:
91+
label: Demo page/post URL
92+
description: Public demo path showing the plugin in action.
93+
placeholder: https://your-site.example/plugins/my-plugin-demo
94+
validations:
95+
required: true
96+
97+
- type: input
98+
id: maintainer_contact
99+
attributes:
100+
label: Maintainer contact
101+
description: Primary maintainer handle or contact URL.
102+
placeholder: https://github.com/your-handle
103+
validations:
104+
required: true
105+
106+
- type: textarea
107+
id: notes
108+
attributes:
109+
label: Additional notes
110+
description: Add context, migration notes, or caveats.
111+
validations:
112+
required: false

0 commit comments

Comments
 (0)