Skip to content

Documentation Cleanup & Optimization Project #181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
logbie merged 23 commits into from
Dec 1, 2025
Merged

Documentation Cleanup & Optimization Project #181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
2502a25
docs: Add complete AI reference for WFL language
logbie Nov 30, 2025
5cf8717
Fixes off-by-one error in loop iteration limit
logbie Dec 1, 2025
26f8c72
Implements timeout for 'wait for request' statements
logbie Dec 1, 2025
43408df
docs: Add crypto module documentation
logbie Dec 1, 2025
dc40331
docs: Clarify WFL-io.md implementation status
logbie Dec 1, 2025
de3e032
docs: Add 4 missing text module functions
logbie Dec 1, 2025
38385a0
docs: Add API validation tracking document
logbie Dec 1, 2025
c08e54b
docs: Complete Week 1 validation - add list & filesystem
logbie Dec 1, 2025
f1b5f10
docs: Consolidate pattern matching documentation (4→1)
logbie Dec 1, 2025
00f3c7f
docs: Consolidate LSP documentation (3→1)
logbie Dec 1, 2025
6d58107
docs: Retire WFL-AI-Reference.md (143KB duplicate)
logbie Dec 1, 2025
cd1f6d8
docs: Archive all dev-notes (Week 3 Days 1-3)
logbie Dec 1, 2025
50ba7c7
docs: Trim stdlib index to navigation TOC (Week 3 Day 4)
logbie Dec 1, 2025
97e3c7a
docs: Add cross-reference headers for async docs (Week 3 Day 5)
logbie Dec 1, 2025
79fb5ac
docs: Fix links in documentation index (Week 4 Day 1-2)
logbie Dec 1, 2025
d8e1be9
docs: Improve wfl-living-ai.md as primary AI reference (Week 4 Day 3)
logbie Dec 1, 2025
470714d
docs: Add Back to Top navigation links (Week 4 Day 5)
logbie Dec 1, 2025
da0dfbf
docs: Document remaining TODOs (Week 5 Day 2)
logbie Dec 1, 2025
b629182
docs: Update master index with cleanup statistics (Week 5 Day 5)
logbie Dec 1, 2025
a82ccc2
docs: Add comprehensive cleanup project summary (Week 6 Day 1-2)
logbie Dec 1, 2025
c1aebc6
Refactor interpreter code and update local settings
logbie Dec 1, 2025
6f59e5c
Remove temporary flush test files
logbie Dec 1, 2025
6ba6004
docs: Remove outdated AI rules and VS Code extension files
logbie Dec 1, 2025
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
597 changes: 0 additions & 597 deletions .augment/rules/DEVELOPMENT.md
View file
Open in desktop

This file was deleted.

52 changes: 0 additions & 52 deletions .augment/rules/Docs.md
View file
Open in desktop

This file was deleted.

115 changes: 0 additions & 115 deletions .augment/rules/Fundimentals.md
View file
Open in desktop

This file was deleted.

15 changes: 0 additions & 15 deletions .augment/rules/Wfl-scripts.md
View file
Open in desktop

This file was deleted.

9 changes: 8 additions & 1 deletion .claude/settings.local.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,14 @@
"Bash(cargo test:*)",
"Bash(gh run view:*)",
"Bash(python:*)",
"Bash(gh run list:*)"
"Bash(gh run list:*)",
"Bash(dir \"G:\\Logbie\\wfl\\Docs\" /s /b)",

@coderabbitai coderabbitai Bot Dec 1, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

git ls-files -o --exclude-standard | grep -E "settings|\.gitignore" | head -20

Repository: WebFirstLanguage/wfl

Length of output: 46

🏁 Script executed:

cd .claude && pwd && ls -la

Repository: WebFirstLanguage/wfl

Length of output: 330

🏁 Script executed:

cat .gitignore 2>/dev/null | grep -E "settings|\.claude" || echo "No .gitignore entries found for settings or .claude"

Repository: WebFirstLanguage/wfl

Length of output: 86

🏁 Script executed:

cat -n .claude/settings.local.json

Repository: WebFirstLanguage/wfl

Length of output: 690

Remove hardcoded machine-specific path from version-controlled settings.

Line 14 contains an absolute Windows path (G:\Logbie\wfl\Docs) that is specific to a developer's local machine. This file is checked into the repository and will fail on other developers' machines or CI/CD systems.

If this path is needed for local development, consider:

  1. Adding .claude/settings.local.json to .gitignore and maintaining it only locally, or
  2. Using a relative path from the repository root (e.g., Docs), or
  3. Using environment variables or build-time substitution.

Additionally, the new wildcard permissions (dir:*, find:*, cat:*) on lines 15–17 grant broad file-reading capabilities. Confirm whether these are intentional for the documentation cleanup objectives or if more scoped permissions would be appropriate.

🤖 Prompt for AI Agents 
.claude/settings.local.json around line 14 contains a hardcoded absolute Windows
path ("G:\Logbie\wfl\Docs") that is machine-specific and must be removed or made
local-only; replace it with a repository-relative path (e.g., "Docs"), or read
the path from an environment variable, or remove the entry and add
.claude/settings.local.json to .gitignore so the local file is not committed;
while editing, review lines 15–17 that grant dir:*, find:*, cat:* permissions
and either narrow them to the smallest required scopes or confirm they are
intentional for documentation cleanup before keeping them.

"Bash(dir:*)",
"Bash(find:*)",
"Bash(cat:*)",
"Bash(for file in \"G:\\Logbie\\wfl\\Docs\"/**/*.md)",
"Bash(do wc:*)",
"Bash(done)"
],
"deny": [],
"ask": []
Expand Down
Loading