8 Commits

Author SHA1 Message Date
Vijay Janapa Reddi
fa5923610a docs: add top-level community health files (CONTRIBUTING, CoC, SECURITY, CITATION) and dependabot
Aligns the repository with GitHub community-standard recommendations and
makes the project's policies discoverable from the root, where contributors
and tooling actually look for them.

- CONTRIBUTING.md (root): router to per-project guides plus universal
  policies (branch from dev, ./book/binder setup, no `git add .`).
- CODE_OF_CONDUCT.md (root): canonical Contributor Covenant 2.1, lifted
  from book/docs/. The book/docs version becomes a thin pointer so we
  have a single source of truth.
- SECURITY.md: private vulnerability reporting via GitHub Security
  Advisory + maintainer email, with explicit in-scope/out-of-scope
  boundaries (textbook typos are not security issues).
- CITATION.cff: machine-readable mirror of CITATION.bib so GitHub's
  "Cite this repository" button works.
- .github/dependabot.yml: weekly bumps against `dev` for every actual
  ecosystem in the repo (pip, npm, github-actions), grouped where it
  makes sense (Next/React together).
- .github/ISSUE_TEMPLATE/config.yml: blank_issues_enabled=false to keep
  reports on-template; added security-advisory contact link.
2026-04-22 17:06:45 -04:00
Vijay Janapa Reddi
4982446696 Add comprehensive binder documentation and clean up duplicate docs
Added BINDER.md with complete CLI documentation including:
- Quick start guide and installation instructions
- Comprehensive command reference with examples
- Advanced features (unified builds, fast build mode)
- Development workflow and troubleshooting guide
- Integration details and performance tips

Updated README.md to highlight binder as recommended development tool:
- Added binder CLI section with key commands
- Updated project structure to show binder and config files
- Fixed documentation links to point to docs/ directory

Cleaned up duplicate documentation:
- Removed root-level BUILD.md, CODE_OF_CONDUCT.md, DEVELOPMENT.md,
  MAINTENANCE_GUIDE.md, contribute.md (kept updated versions in docs/)
- Consolidated all documentation in docs/ directory
- Updated all references to use docs/ path

This streamlines the development experience and reduces confusion
about which documentation files are current.
2025-07-28 15:37:32 -04:00
Vijay Janapa Reddi
0048bb6efa restore: bring back essential configuration and documentation files
RESTORED FILES:
Configuration files:
- .all-contributorsrc (contributor management)
- .codespell-ignore (spelling check exclusions)
- .lycheeignore (link checking exclusions)
- .markdownlintignore (markdown linting exclusions)
- .mdlintconfig.yml (markdown linting configuration)
- .vale.ini (prose linting configuration)

Documentation files:
- BUILD.md (build instructions)
- CODE_OF_CONDUCT.md (community guidelines)
- DEVELOPMENT.md (development setup)
- MAINTENANCE_GUIDE.md (maintenance procedures)
- contribute.md (contribution guidelines)

RATIONALE:
- Preserves essential development tooling configuration
- Ensures linting/quality checks remain functional across branches
- Maintains documentation availability when switching back to dev branch
- Balances clean project structure with development workflow needs
2025-07-25 18:42:02 -04:00
Vijay Janapa Reddi
e396ff9bfd refactor: reorganize project structure and remove config files from root
REMOVED FROM ROOT:
- Configuration files: .all-contributorsrc, .codespell-ignore, .lycheeignore, .markdownlintignore, .mdlintconfig.yml, .vale.ini
- Documentation files: BUILD.md, CODE_OF_CONDUCT.md, DEVELOPMENT.md, MAINTENANCE_GUIDE.md, contribute.md

BENEFITS:
- Cleaner root directory structure
- Reduced clutter for better project navigation
- Configuration files moved to appropriate config/ subdirectories
- Documentation consolidated in docs/ folder
2025-07-25 18:39:14 -04:00
Vijay Janapa Reddi
7a12db3762 Adding pre-commit + test run 2025-02-03 22:40:31 -05:00
naeemkh
8d65eddcc0 fix the email addresses 2023-12-10 20:09:31 -05:00
naeemkh
44520e0832 address linter issues 2023-12-10 18:57:25 -05:00
naeemkh
7e8f68d1eb add code of conduct 2023-12-10 18:50:50 -05:00