Fix issues with the document site link and minor issues

[sameeragunarathne]

$Subject.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a15fc262-8f8f-4c0d-80bd-23466049f368

📥 Commits

Reviewing files that changed from the base of the PR and between d25f345 and 61f1c52.

📒 Files selected for processing (9)

• .github/workflows/publish_docs.yaml
• en/docs/install-and-setup/deploy-docker.md
• en/docs/secure-health-apis/guides/configure-smart-on-fhir.md
• en/docs/secure-health-apis/guides/smart-on-fhir-overview.md
• en/docusaurus.config.js
• en/docusaurus.config.ts
• en/package.json
• en/sidebars.js
• en/sidebars.ts

---

📝 Walkthrough

Overview

This PR addresses document site link configuration issues and makes improvements to documentation formatting, navigation structure, and build processes. The changes are primarily focused on migrating to a properly configured Docusaurus setup with consistent documentation organization.

Key Changes

Site Configuration & Deployment

• BASE_URL Fix: Updated the GitHub Actions workflow to use a fixed subpath /open-healthcare-docs/ instead of dynamically deriving it from the repository name, ensuring consistent site link generation
• Build Scripts: Added new npm scripts (build:local, swizzle, deploy, clear) and updated the serve command to execute a local build first

Documentation Structure & Navigation

• Sidebar Reorganization: Restructured sidebars.js and sidebars.ts with improved category labels ("Working with FHIR", "Working with HL7") and converted string paths to explicit documentation objects for better consistency
• Content Exclusion: Added exclusion rules in Docusaurus config files to ignore content matching **/old-content/** pattern

Documentation Formatting

• Placeholder Consistency: Updated inline placeholders (e.g., <DOCKER_HOST>, <APIM_HOME>) to use proper Markdown formatting with angle brackets across multiple documentation files
• Code Block Formatting: Reformatted code examples in SMART on FHIR documentation to use inline code syntax (backticks) and improved indentation for proper list rendering

Impact

These changes improve the documentation site's accessibility with a stable URL configuration, enhance the sidebar navigation with more granular categorization, and ensure consistent formatting across documentation files.

Walkthrough

This PR modernizes the open healthcare documentation build and navigation structure. The workflow's Docusaurus base URL is fixed to /open-healthcare-docs/, and both JavaScript and TypeScript Docusaurus configuration files are updated to exclude legacy content via the **/old-content/** pattern. Package.json npm scripts are extended with new build, deployment, and helper commands. The sidebar structure is restructured with expanded nested categories for "Working with FHIR" and "Working with HL7", converting shorthand entries to explicit doc-item objects with IDs and labels. Documentation content receives formatting consistency updates to placeholder references and code examples across Docker deployment, SMART on FHIR, and API documentation files.

Suggested reviewers

• isuruh15

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description consists only of '$Subject.' with no substantive information about the changes, objectives, or impact of the pull request.	Provide a meaningful description that explains the purpose of the changes, affected areas, and any context needed for reviewers to understand the modifications.
Title check	❓ Inconclusive	The title addresses fixes related to document site links and minor issues, but lacks specificity about the actual changes made across multiple files and configuration updates.	Consider a more descriptive title that reflects the primary changes, such as 'Update Docusaurus config, sidebars, and documentation formatting' or specify which 'document site link' issue was resolved.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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.}