TL;DR: AIPs are lots of documents on how we do APIs.
AIP stands for API Improvement Proposal, which is a design document providing high-level, concise documentation for API development. The goal is for these documents to serve as the source of truth for API-related documentation at Thryv and the way API teams discuss and come to consensus on API guidance. The program is named and styled after Python's enhancement proposals (PEPs) which have seemed to work pretty well over the years.
While much of the API-related guidance is general and spans across all the different products at Thryv, we've found that some teams working in different areas may have different customs, styles, or guidance. To accommodate these historical differences, we've provided separate blocks of numbers for those areas where they might override or extend the more general guidance.
If you're new to AIPs, check out the [Frequently Asked Questions][], which answer some common questions about how AIPs work and what you need to know.
If you have an idea for an AIP that isn't written yet (yes, there are plenty!) check out Contributing to the project to see how you can write AIPs for others to follow.
git clone [email protected]:infusionsoft/thryv.aip.dev.git
cd thryv.aip.devExecute the serve.sh script, which will build and run the docker container:
./serve.shThe AIP site should now be accessible at:
- Main site: http://localhost:4000
- Live reload: http://localhost:35729
To stop the running container, press CTRL+C to quit, and the container will automatically destroy itself.
Except as otherwise noted, the content of this repository is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License.
For the full text of each license, see LICENSE.md.