Personal Website Portfolio

This is my personal website portfolio -- including my resume, project highlights, work samples, technical reference documentation, and the occasional blog post. It is built with Docusaurus.

Developer Guide

• Package Manager: pnpm
• Linter:
  • TypeScript: ESLint
  • CSS: Stylelint
  • Markdown: markdownlint
• Code Formatter:
  • Prettier
  • Markdown: Markdown All in One
• Pre-Commit Hooks: prek

cd website
# Install pnpm with corepack and run pnpm install
npm run init
# shamefully-hoist to handle issues with docusaurus-lunr-search
pnpm install --shamefully-hoist

# Start a local instance
pnpm run start

# Type check, lint, format
pnpm run typecheck
pnpm run lint
pnpm run format

# Install pre-commit hooks
prek install

Key Development Principles

• Maintain 100% passing tests, at least 80% test coverage, formatting, and linting before opening a pull request.
• Update docstrings alongside code changes to keep the generated reference accurate.

Contributing

Contributions are welcome -- where appropriate for correcting things like spelling errors, bugs, or suboptimal code/configurations. To get started:

1. Fork the repository and create a new branch.
2. Install development dependencies (see the developer guide).
3. Add or update tests together with your change.
4. Run the full test, linting, and formatting suite locally.
5. Submit a pull request describing your changes and referencing any relevant issues.

For major changes, open an issue first to discuss your proposal.

Contact

Questions or issues regarding this project's source code or my documentation? Please open an issue on the repository's issue tracker.

Looking to work with me? Visit my online portfolio for contact information.