docs: Fix docs generation

[mtrezza]

Summary by CodeRabbit

• Chores

  • Switched documentation generation input to use built/packaged sources instead of source files.

• New Features

  • Added a manual workflow to trigger creation and deployment of documentation releases to the website.

[parse-github-assistant]

🚀 Thanks for opening this pull request!

[coderabbitai]

📝 Walkthrough

Walkthrough

Updated JSDoc source include paths from ./src/... to ./lib/..., and added a new GitHub Actions workflow release-manual-docs.yml that allows manually-triggered documentation releases which build docs and publish them to GitHub Pages.

Changes

Cohort / File(s)	Summary
JSDoc configuration jsdoc-conf.json	Replaced documentation include paths pointing at ./src/... with ./lib/... for cloud-code, Options/docs.js, ParseServer.js, and adapter entries.
Manual docs release workflow .github/workflows/release-manual-docs.yml	Added workflow to manually trigger docs release with required ref input; checks out specified ref, sets up Node.js v18.20.4, caches npm, runs npm ci and release_docs.sh with SOURCE_TAG, and deploys ./docs to GitHub Pages via peaceiris/actions-gh-pages.

Sequence Diagram(s)

sequenceDiagram
  participant User as Developer (manual trigger)
  participant GH as GitHub Actions
  participant Repo as Repository
  participant Runner as Actions Runner (ubuntu)
  participant Node as Node.js env
  participant Script as release_docs.sh
  participant GH_Pages as GitHub Pages (peaceiris)

  rect rgb(235,245,255)
    User->>GH: Manually trigger release-manual-docs.yml (input: ref)
    GH->>Runner: Start `docs` job (checkout specified ref)
    Runner->>Repo: actions/checkout@v4 at provided ref
  end

  rect rgb(245,255,235)
    Runner->>Node: Setup Node.js v18.20.4
    Runner->>Runner: Restore npm cache (lockfile key)
    Runner->>Runner: Run `npm ci`
    Runner->>Script: Execute `release_docs.sh` (env: SOURCE_TAG=ref)
    Script->>Runner: Generate docs into ./docs
  end

  rect rgb(255,245,235)
    Runner->>GH_Pages: peaceiris/actions-gh-pages deploy (`./docs`, GITHUB_TOKEN)
    GH_Pages-->>Runner: Publish result
    Runner-->>GH: Job complete (success/failure)
  end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Verify ./lib/... paths exist and contain the intended source files used by JSDoc.
• Confirm release_docs.sh exists, is executable, and correctly uses SOURCE_TAG.
• Check workflow security: usage of GITHUB_TOKEN, repo settings for gh-pages, and no plaintext secrets.
• Validate cache key logic and Node version compatibility.
• Ensure the workflow behaves correctly when given both tags and SHAs.

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The pull request description is entirely empty, with no content provided by the author. The repository template requires several key sections including an issue link (Closes:), an Approach section describing the changes, and a Tasks section with checkboxes. The absence of any description violates the basic requirement to provide context about the changes, making it impossible to understand the motivation, approach, or associated issue for this fix. This represents a complete failure to follow the contribution guidelines for the repository.	The author should add a comprehensive pull request description that includes a link to the associated issue (Closes: #XXXX), a detailed explanation of the approach and rationale for the changes in the Approach section, and completion of any relevant tasks from the Tasks section. At minimum, the Issue and Approach sections must be filled out to provide reviewers with sufficient context to understand and evaluate the changes.
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title "docs: Fix docs generation" is directly related to the main changes in the pull request. The changeset modifies jsdoc-conf.json to update source paths for documentation generation and introduces a new GitHub Actions workflow for manual documentation releases. The title clearly communicates that the primary objective is fixing documentation generation, which aligns with both changes. The title is concise, specific, and provides meaningful context about the main purpose of the changeset.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[parseplatformorg]

✅ Snyk checks have passed. No issues have been found so far.

Status	Scanner	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

.github/workflows/release-manual-docs.yml (2)

9-12: Remove redundant default value when input is required.

The ref input has required: true which means it must be provided at workflow trigger time. The default: '' is therefore unreachable and adds unnecessary confusion.

Apply this diff to remove the redundant default:

      ref:
-       default: ''
        description: 'Reference (tag / SHA):'
        required: true

---

33-39: Clarify the purpose of echoing the SOURCE_TAG variable.

The echo $SOURCE_TAG on line 35 appears to be debug output, but it's unclear if this is intentional. If used for logging/traceability, consider documenting the purpose; otherwise, consider removing it to reduce log verbosity.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 863b257 and 6e4f474.

📒 Files selected for processing (1)

• .github/workflows/release-manual-docs.yml (1 hunks)

🔇 Additional comments (2)

.github/workflows/release-manual-docs.yml (2)

1-44: Workflow structure is sound.

The workflow follows GitHub Actions best practices:

• Action versions are pinned for reproducibility (checkout@v4, setup-node@v4, cache@v4).
• Node.js version is pinned (18.20.4).
• Timeout is reasonable for docs generation (15 minutes).
• Secrets handling is secure (uses built-in GITHUB_TOKEN).
• Clear documentation in the header comments.

---

18-44: All workflow prerequisites verified and in place.

The release_docs.sh script exists, is executable, properly uses the SOURCE_TAG environment variable, and correctly generates and populates the ./docs directory for deployment. The workflow is properly configured.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.99%. Comparing base (ea91aca) to head (6e4f474).
⚠️ Report is 5 commits behind head on alpha.

Additional details and impacted files

@@            Coverage Diff             @@
##            alpha    #9899      +/-   ##
==========================================
+ Coverage   92.98%   92.99%   +0.01%     
==========================================
  Files         187      187              
  Lines       15177    15177              
  Branches      177      177              
==========================================
+ Hits        14112    14114       +2     
+ Misses       1053     1051       -2     
  Partials       12       12              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.