Skip to content

Commit da46b3e

Browse files
authored
Move docs to docs/site; add Gemfile for local Jekyll preview
* Move docs to docs/site; add Gemfile + local Jekyll preview doc Separate published Jekyll content (docs/site/) from any internal docs that may live alongside it later (ADRs, plans, research, etc.). Matches the convention used by hyperbee.migrations and the cookiecutter. - Move all Jekyll content and docs.projitems/docs.shproj into docs/site/ - docs.projitems paths auto-resolve via $(MSBuildThisFileDirectory) - Update .slnx to point at docs/site/docs.shproj - Update deploy workflow to build from ./docs/site - Delete .todo.md - Add docs/site/Gemfile for local Jekyll preview - Add docs/site/local-jekyll.md onboarding doc - .gitignore: add Jekyll build artifacts * Also ignore .claude/ (Claude Code scratch dir) * Strip UTF-8 BOMs and replace non-ASCII chars with ASCII just-the-docs / Jekyll fails intermittently on files with BOMs or stray Unicode. Sweep docs/site/: - Strip BOM (EF BB BF) from all text files (*.md, *.yml, *.html) - Replace em-dash \u2014 with -- - Replace en-dash \u2013 with - - Replace nbsp U+00A0 with regular space - Replace right arrow \u2192 with -> - Replace mu \u03bc with u (microseconds become us in benchmark tables)
1 parent a595aec commit da46b3e

12 files changed

Lines changed: 456 additions & 8 deletions

File tree

.github/workflows/deploy_github_pages.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
- name: Build with Jekyll
3434
uses: actions/jekyll-build-pages@v1
3535
with:
36-
source: ./docs
36+
source: ./docs/site
3737
destination: ./_site
3838
- name: Upload artifact
3939
uses: actions/upload-pages-artifact@v3

.gitignore

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -395,4 +395,15 @@ FodyWeavers.xsd
395395
*.msp
396396

397397
# JetBrains Rider
398-
*.sln.iml
398+
*.sln.iml
399+
# Jekyll / GitHub Pages local build
400+
_site/
401+
.jekyll-cache/
402+
.jekyll-metadata
403+
.sass-cache/
404+
vendor/
405+
.bundle/
406+
docs/site/Gemfile.lock
407+
408+
# Claude Code scratch directory (local, not shared)
409+
.claude/

Hyperbee.Resources.slnx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<File Path="NuGet.Config" />
77
<File Path="README.md" />
88
<File Path="version.json" />
9-
<Project Path="docs/docs.shproj" />
9+
<Project Path="docs/site/docs.shproj" />
1010
</Folder>
1111
<Folder Name="/Solution Items/.github/">
1212
<File Path=".github/dependabot.yml" />

docs/.todo.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/site/Gemfile

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
source "https://rubygems.org"
2+
3+
gem "jekyll", "~> 4.3"
4+
gem "just-the-docs"
5+
6+
group :jekyll_plugins do
7+
gem "jekyll-remote-theme"
8+
gem "jekyll-include-cache"
9+
gem "jekyll-seo-tag"
10+
gem "jekyll-relative-links"
11+
end
12+
13+
gem "webrick", "~> 1.8"
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
title: Hyperbee Resources
1+
title: Hyperbee Resources
22
description: Documentation for Hyperbee Resources.
33
remote_theme: pmarsceill/just-the-docs
44
baseurl: "/hyperbee.resources/"
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
<footer class="site-footer">
1+
<footer class="site-footer">
22
Hyperbee Resources Docs
33
</footer>
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)