Skip to content

chore: cleanup docs, update gitignore, add markdownlint - #24

Merged
aadil96 merged 1 commit into
mainfrom
chore/cleanup-docs-gitignore
Jul 11, 2026
Merged

chore: cleanup docs, update gitignore, add markdownlint#24
aadil96 merged 1 commit into
mainfrom
chore/cleanup-docs-gitignore

Conversation

@aadil96

@aadil96 aadil96 commented Jul 11, 2026

Copy link
Copy Markdown
Owner

Summary

  • Remove stale docs (architecture, operations, references, workflows READMEs)
  • Add markdownlint-cli and package.json
  • Fix 148 markdownlint violations across 7 files
  • Update .gitignore for node_modules

Test Plan

  • Verify markdownlint passes: npx markdownlint '**/*.md' --ignore node_modules
  • Verify no secrets in committed files

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@what-the-diff

what-the-diff Bot commented Jul 11, 2026

Copy link
Copy Markdown

PR Summary

  • Enhancements in .gitignore
    The inclusion of node_modules/ in .gitignore file helps prevent unnecessary tracking of Node Package Manager (npm) files, streamlining the codebase.
  • Formatting Updates in README.md
    The code block syntax has been updated from plain to text in README.md, making the instructions more user-friendly and clear.
  • Clean-Up of Documentation Files
    Files such as architecture, operations, and references have been taken out from the documentation, removing any potential outdated or redundant information.
  • Refinement of Table Formatting in Design Document
    Table formatting in docs/superpowers/plans/2026-05-16-opencode-org-model-design.md was fixed to improve readability.
  • Updated Paths in Specification Document
    Explicit $HOME/.zsh/ prefix is now used for paths in docs/superpowers/specs/2026-05-14-zsh-autosuggestions-design.md, adding more clarity while navigating through the files.
  • Unified Markdown Formatting
    Inconsistent Markdown formatting across various files has been corrected for a more uniform presentation across headers, tables, and code blocks.
  • Creation of package.json
    Introduced package.json to include development dependency for markdownlint-cli, facilitating easy setup for potential contributors.
  • Design Document Updates
    Non-functional updates related to organizational model and processes were made in design documents, providing consistent formatting and structure.
  • Environment Variable Table Completion in README-ollama.md
    Comprehensive environment variable table has been included in README-ollama.md.
  • Instructions Clarity
    User instructions and documentation around tmux commands in tmux-cheatsheet.md have been enhanced for clearer understanding.

@aadil96
aadil96 merged commit 31886dc into main Jul 11, 2026
3 checks passed
@aadil96
aadil96 deleted the chore/cleanup-docs-gitignore branch July 11, 2026 09:02
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.

1 participant