Skip to content

Feat: Add Reference Docs Versioning - #1663

Open
buzzamus wants to merge 1 commit into
mainfrom
docs-update
Open

Feat: Add Reference Docs Versioning#1663
buzzamus wants to merge 1 commit into
mainfrom
docs-update

Conversation

@buzzamus

@buzzamus buzzamus commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Summary of changes

  • This PR moves Dokka output off of the main branch (docs/) and into a git ignored build directory, then publishes it to a separate reference-docs branch via the new publish-docs.sh script.

A follow up PR to generate the docs will follow once this is merged to remove docs/ and then switch over to new docs.

  • to test/preview docs you can follow these steps locally:
  1. run the publish script with ./scripts/publish-docs.sh 5.30.0-test
  2. cd ../braintree_android-reference-docs
  3. preview the docs in the browser (an easy way to set up a local server is with python3 -m http.server 8000 and then go to http://localhost:8000/ → should redirect to current/index.html and then also try http://localhost:8000/5.30.0-test/

AI Usage

Which AI Agent Was Used?

  • Copilot
  • Claude
  • Other (Type Name Here)

How was AI used?
Used for initial research, creating bash script to mimic iOS docs behavior

Estimated AI Code Contribution

  • less than 30%
  • 30 - 60%
  • 60 - 100%

Checklist

  • Added a changelog entry
  • Tested and confirmed payment flows affected by this change are functioning as expected

Authors

List GitHub usernames for everyone who contributed to this pull request.

@buzzamus
buzzamus requested a review from a team August 4, 2026 15:57
@buzzamus
buzzamus requested a review from a team as a code owner August 4, 2026 15:57
@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown

Dependency Review

The following issues were found:
  • ✅ 0 vulnerable package(s)
See the Details below.

Scanned Files

  • settings.gradle

@noguier

noguier commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Can you give me a context why the decision was made to move the docs into a separate branch?

@buzzamus

buzzamus commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

Can you give me a context why the decision was made to move the docs into a separate branch?

Yep! I sent you the document on the outlined possible solutions. This idea that was settled on was to match what iOS already does, which moves docs off of main

Comment thread scripts/publish-docs.sh
exit 1
fi

if ! git -C "${REPO_ROOT}" worktree list --porcelain | grep -qx "worktree ${WORKTREE_DIR}"; then

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The script looks great, but i have difficulty parsing through this conditions.
As far as I understand we first check if this directory already exist,
if not we check if the local branch with that name exists,
if it does we add it to the new folder,
if not we create a orphaned new branch.

Is that roughly correct?

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.

2 participants