Think Company is an experience design consultancy located in Philadelphia, PA. We have a fantastic team of designers and developers focused on providing beautiful, user-centered, accessible digital products.
This repository contains the standards, in Markdown, by which Think Company developers write outstanding technical products for our clients. You can find them in the content directory.
This codebase uses Gatsby to consume those Markdown files and generate a static website.
To make updates to the static version of our docs site, you'll need to:
- Install Node.js LTS
- or use nvm or nvm-windows
- Clone this repository to your local machine:
git clone [email protected]:thinkcompany/think_dev-standards.git - In your terminal,
cdto the root of this project directory - Run
npm installto install Node dependencies and build the site - Run
npm startto start the Gatsby development server. - Navigate to: http://localhost:8000 to get started.
- Production: http://standards.thinkcompany.dev
- Each branch pushed to
originresults in Netlify building a branch deploy. - Each pull request created results in Netlify building a deploy preview.
This site uses Netlify to build and host the site.
Please open an issue for support, or use the #ui-dev channel in Think Company Slack.
Please contribute using Gitflow Workflow. Create a branch, add commits, and open a pull request.
Branch names should follow the following formats:
- New features / additions:
feature/THINKDOCS-0000-new-feature-name(whereTHINKDOCS-000is the issue key) - Bugfixes:
fix/THINKDOCS-0000-bugfix-description - Releases:
release/release-1.0.0
If you solve a tricky bug, the next person who works on this codebase will appreciate you including a Stack Overflow or Github Issue link to help understand why the change was made!