Skip to content

feat: treat main branch as dev version for Operator docs #651

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat: treat main branch as dev version for Operator docs #651

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
05c22a3
feat: return "dev" for Operator main branch
Oreoxmt Nov 21, 2025
05bb57f
feat: return "dev" for Operator main branch
Oreoxmt Nov 21, 2025
844daba
refactor
Oreoxmt Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions gatsby/path.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ function branchToVersion(repo: Repo, branch: string) {
const stable = CONFIG.docs[repo].stable;
switch (branch) {
case "master":
case "main":
Copy link

@gemini-code-assist gemini-code-assist bot Nov 21, 2025

Choose a reason for hiding this comment

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

medium

Good catch adding main here. I see this branchToVersion function is also present in src/shared/utils/index.ts. Let's keep our codebase DRY and consolidate them. We should export the one from src/shared/utils/index.ts and use it here.

return "dev";
case stable:
return "stable";
Expand Down
1 change: 1 addition & 0 deletions gatsby/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ export function getStable(doc: Repo) {
function renameVersion(version: string, stable: string | undefined) {
switch (version) {
case "master":
case "main":
Copy link

@gemini-code-assist gemini-code-assist bot Nov 21, 2025

Choose a reason for hiding this comment

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

medium

Thanks for updating this. This renameVersion function is almost a mirror of convertVersionName in src/shared/utils/index.ts. To avoid future maintenance headaches, let's merge them. The version in shared/utils should probably be updated to handle an undefined stable version, and then we can use it here.

return "dev";
case stable:
return "stable";
Expand Down
2 changes: 2 additions & 0 deletions src/shared/utils/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ function branchToVersion(repo: Repo, branch: string) {
const stable = CONFIG.docs[repo].stable;
switch (branch) {
case "master":
case "main":
return "dev";
case stable:
return "stable";
Expand Down Expand Up @@ -217,6 +218,7 @@ export const AllVersion = Object.keys(CONFIG.docs).reduce((acc, val) => {
export function convertVersionName(version: string, stable: string) {
switch (version) {
case "master":
case "main":
return "dev";
case stable:
return "stable";
Expand Down