Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API Architecture doc blog post #2345

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mikesmit
Copy link
Collaborator

@mikesmit mikesmit commented Feb 6, 2025

fixes #2344

  1. Created an article on the new design
  2. added myself and a photo of me as an author
  3. added the article to the manifest

@mikesmit mikesmit requested a review from MaxGhenis February 6, 2025 16:33
Copy link

vercel bot commented Feb 6, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
policyengine-app ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 10, 2025 7:41pm

Copy link
Collaborator

@anth-volk anth-volk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @mikesmit, thanks for your work on this. I limited the scope of my review to the technical implementation, as Max would be responsible for language, but did note a required change before we can merge.

{ "title": "How We're Improving our API in 2025",
"description": "PolicyEngine's API target architecture for 2025.",
"date": "2025-02-05",
"tags": ["technical"],
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

important, blocking: Please add "global" as a tag

At the moment, all posts require a geographic tag to be displayed on the site.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Will fix.

Copy link
Collaborator

@anth-volk anth-volk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great @mikesmit! If you could just run the linter and merge, pending approval of the content, this will be good to merge.

Copy link
Contributor

@MaxGhenis MaxGhenis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you run make format to pass lint? Please also confirm you tested it locally.

"date": "2025-02-05",
"tags": ["technical", "global"],
"authors": ["michael-smit"],
"filename": "policyengine_api_v2.md",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use dashes by convention. Don't think we need policyengine in the URL. Please also rename image as the same.

Suggested change
"filename": "policyengine_api_v2.md",
"filename": "api-v2.md",

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: PR: Review Requested
Development

Successfully merging this pull request may close these issues.

Publish target API architecture on blog
3 participants