-
Notifications
You must be signed in to change notification settings - Fork 91
Upgrade Readme #2125
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
Upgrade Readme #2125
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
289d7a3 to
02620d9
Compare
02620d9 to
ca6ebc4
Compare
6b21517 to
00e0f2c
Compare
API Reference Preview🚀 https://developer.mixpanel.com/v3.27-pr-2125/reference/overview |
| "autoprefixer": "10.4.21", | ||
| "cspell": "9.2.1", | ||
| "postcss": "8.5.6", | ||
| "rdme": "8.6.6", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can remove this package since we aren't using anywhere (our use case is not supported in the latest rdme package)
b58bacb to
6b8397b
Compare
6b8397b to
b099f2a
Compare
* remove rdme package * try creating readme version * update readme version * change the branch semver to 3.27 * re-upload updated reference folder * run reference conversion * change language back to version * more frontmatter linting * remove noindex meta but add robots * modify delete staging and docs * uncomment staging * add category to markdown files * switch actiion * delete the index files * try using a specific tag * find the pinned commit hash * remove robots
Goals for this PR:
The main changes are within the github workflows, and should be a 1/1 change using either rdme's v10 or curl commands directly from their docs.
We can delete the rdme package since we aren't using it. Our use cases are only available via github actions or curl request.
The content changes within reference involved downloading the up to date version for readme directly, running it through frontmatter and removing the offending code, and adding a category to each page.
The one main change here is that metadata has been removed, which means things that used to be marked as
noindexfor search engines is now removed. You can see all the pages that this affects in this commit: b099f2a , which aren't that many.Openapi changes need to go first via #2124
docs: