Skip to content

Conversation

@tiffanyqi
Copy link
Collaborator

@tiffanyqi tiffanyqi commented Sep 30, 2025

Goals for this PR:

  1. Create a readme branch (used to be called version) using curl
  2. Push the docs to the staging env (using rdmev10 since we can)
  3. Output the comment with the updated branch
  4. Upon merge, push the changes to production
  5. Upon merge, delete the branch

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 noindex for 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:

@tiffanyqi tiffanyqi requested review from a team as code owners September 30, 2025 02:06
@tiffanyqi tiffanyqi requested review from junhouse and santigracia and removed request for a team September 30, 2025 02:06
@vercel
Copy link

vercel bot commented Sep 30, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs Ready Ready Preview Comment Oct 2, 2025 6:53pm

@github-actions
Copy link

github-actions bot commented Oct 2, 2025

API Reference Preview

🚀 https://developer.mixpanel.com/v3.27-pr-2125/reference/overview
Last updated: 10/2/2025, 11:54:07 AM PT from 528dde5

"autoprefixer": "10.4.21",
"cspell": "9.2.1",
"postcss": "8.5.6",
"rdme": "8.6.6",
Copy link
Collaborator Author

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)

@tiffanyqi tiffanyqi merged commit 0f76e87 into main Oct 2, 2025
11 checks passed
@tiffanyqi tiffanyqi deleted the tiffany-upgrade-readme branch October 2, 2025 18:58
efahk pushed a commit that referenced this pull request Nov 12, 2025
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants