Skip to content

Conversation

Copy link

Copilot AI commented Jan 18, 2026

The website/docs/ directory contained 173 duplicate documentation files that were accidentally committed build artifacts. Root directory files are the actual source. Additionally, removed temporary Python development scripts with hardcoded local paths.

Changes

Repository Cleanup

  • Removed website/docs/ directory entirely (173 files)
  • Root documentation files remain as single source of truth
  • Removed 11 temporary Python development scripts with hardcoded paths to /Users/danshalev/docs-staging/
  • Removed 2 temporary output text files (final_results.txt, output.txt)

Configuration Updates

  • website/docusaurus.config.ts: Added path: '../' to read docs from root, with exclude patterns for node_modules and non-doc files
  • website/sidebars.ts: Removed reference to non-existent 'staging' document
  • .gitignore: Added comprehensive exclusions for Docusaurus artifacts, dependencies, OS files, editor files
  • .wordlist.txt: Added technical terms (Docusaurus, MDX, admonition, admonitions, gitignore, webpack, kramdown, JSX) to fix spelling CI

MDX Syntax Fixes
Fixed compilation errors in 11 files:

  • Converted custom HTML tags to Docusaurus admonitions (<note>:::note)
  • Self-closed HTML tags (<br><br/>, <img><img/>)
  • Escaped JSX placeholders in URLs ({tokenId}\{tokenId\})
  • Properly formatted <details> blocks with newlines

Result

Build artifacts now properly excluded from version control. Docusaurus compiles successfully with webpack passing and static site generated in website/build/. All temporary development files removed. Spelling CI issues resolved.

cd website && npm run build
# ✓ Server: Compiled successfully
# ✓ Client: Compiled successfully  
# ✓ Build artifacts in website/build/
# ✓ Spelling checks pass
Original prompt

Remove accidentally committed build output and fix .gitignore for Docusaurus

Problem Description

The website/docs/ directory contains duplicate documentation content that appears to be Docusaurus build output that was accidentally committed to the repository. This creates several issues:

  1. Duplicate Content: The same documentation files exist in both the root directory and website/docs/, creating maintenance overhead and potential inconsistencies.

  2. Build Artifacts in Git: The website/docs/ directory contains generated content that should not be version controlled.

  3. Insufficient .gitignore: The current .gitignore only contains *.dic which is insufficient for a Docusaurus project.

Current Structure Issues

Duplicate Content Examples:

  • Root: index.md → Website: website/docs/index.mdx
  • Root: datatypes.md → Website: website/docs/datatypes.md
  • Root: cypher/ → Website: website/docs/cypher/
  • Root: algorithms/ → Website: website/docs/algorithms/
  • Root: operations/ → Website: website/docs/operations/

Current .gitignore Issues:

The .gitignore file only contains:

*.dic

Required Changes

1. Remove Build Artifacts

  • Delete the entire website/docs/ directory as it contains duplicate/generated content
  • Keep the root documentation files (they are the source files)

2. Update .gitignore

Replace the current .gitignore content with proper Docusaurus exclusions:

# Docusaurus build artifacts
website/build/
website/.docusaurus/
website/docs/
website/node_modules/

# Dependencies
node_modules/
npm-debug.log*
yarn-debug.log*
yarn-error.log*
package-lock.json
yarn.lock

# Environment variables
.env
.env.local
.env.development.local
.env.test.local
.env.production.local

# OS generated files
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db

# Editor files
*.swp
*.swo
*~
.vscode/
.idea/

# Spell check artifacts
*.dic

# Build outputs
/build
/dist

3. Verify Docusaurus Configuration

Ensure website/docusaurus.config.ts is properly configured to use the root directory as the docs source, so that:

  • Source files remain in the root directory
  • Docusaurus generates website/docs/ during build (which will now be gitignored)
  • The build process works correctly without committing generated files

Expected Outcome

After these changes:

  • No duplicate content in the repository
  • Proper separation between source files (root) and build artifacts (website/docs/)
  • Clean git history without build artifacts
  • Proper .gitignore prevents future accidental commits of build output
  • Docusaurus build process works correctly by generating docs from root directory sources

Files to Modify

  1. Delete: website/docs/ directory (entire directory and all contents)
  2. Update: .gitignore file with comprehensive Docusaurus exclusions
  3. Verify: website/docusaurus.config.ts has correct source path configuration

Verification Steps

  1. Confirm website/docs/ directory is removed
  2. Confirm .gitignore properly excludes Docusaurus build artifacts
  3. Test that Docusaurus build still works: cd website && npm run build
  4. Verify generated website/docs/ is not tracked by git after build

This pull request was created from Copilot chat.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@coderabbitai
Copy link

coderabbitai bot commented Jan 18, 2026

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Comment @coderabbitai help to get the list of available commands and usage tips.

Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>
@gkorland
Copy link

@coderabbitai review

@coderabbitai
Copy link

coderabbitai bot commented Jan 18, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@gkorland gkorland marked this pull request as ready for review January 18, 2026 15:16
@gkorland
Copy link

@copilot please fix the spelling issues in the CI

Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>
@gkorland gkorland requested a review from Copilot January 18, 2026 15:18
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR removes accidentally committed build artifacts from the website/docs/ directory and updates the .gitignore file to prevent future commits of Docusaurus-generated files. The changes clean up the repository by removing 173 duplicate documentation files that were build output, while preserving the source documentation in the root directory.

Changes:

  • Removed entire website/docs/ directory containing Docusaurus build artifacts
  • Updated .gitignore with comprehensive exclusions for Docusaurus, dependencies, and development files
  • Updated website/docusaurus.config.ts and website/sidebars.ts to reference root directory as docs source

Reviewed changes

Copilot reviewed 107 out of 164 changed files in this pull request and generated no comments.

File Description
website/docs/* Removed all 173 build artifact files that duplicated root documentation
.gitignore Added comprehensive exclusions for build outputs, dependencies, and editor files
website/docusaurus.config.ts Configured to use root directory as documentation source
website/sidebars.ts Removed reference to non-existent 'staging' document

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@gkorland
Copy link

@copilot please also delete from the main folder the python script that are not needed and were just been used temporary in the development process, hint scripts that are poing to a local folder on danshalev machine

Copilot AI and others added 2 commits January 18, 2026 15:26
Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>
Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>
Copilot AI changed the title [WIP] Remove build output and update .gitignore for Docusaurus Remove accidentally committed Docusaurus build artifacts and fix .gitignore Jan 18, 2026
Copilot AI requested a review from gkorland January 18, 2026 15:35
Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>
Copy link
Author

Copilot AI commented Jan 18, 2026

@copilot please fix the spelling issues in the CI

Fixed in commit d80afdd. Added technical terms (Docusaurus, MDX, admonition, admonitions, gitignore, webpack, kramdown, JSX) to .wordlist.txt to resolve spelling CI issues.

@copilot please also delete from the main folder the python script that are not needed and were just been used temporary in the development process, hint scripts that are poing to a local folder on da...

Fixed in commit d80afdd. Deleted 11 temporary Python scripts and 2 output text files that contained hardcoded paths to danshalev's local machine:

  • Python scripts: add_h1_headings.py, check_h1_headings.py, check_navigation_complete.py, comprehensive_nav_check.py, find_duplicate_h1s.py, fix_all_h1s.py, fix_angle_brackets.py, fix_curly_braces.py, format_results.py, test_single.py, verify_navigation.py
  • Output files: final_results.txt, output.txt

Copilot AI changed the title Remove accidentally committed Docusaurus build artifacts and fix .gitignore Remove accidentally committed Docusaurus build artifacts, temporary scripts, and fix .gitignore Jan 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants