feat: documentation on how to add custom scripts

[jaredwray]

Please check if the PR fulfills these requirements

• Followed the Contributing and Code of Conduct guidelines.
• Tests for the changes have been added (for bug fixes/features) with 100% code coverage.

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
feat: documentation on how to add custom scripts

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly improves Docula's documentation by introducing a comprehensive guide on integrating custom scripts. It clarifies the process for users to add third-party snippets like analytics or custom JavaScript, ensuring greater flexibility and control over their Docula-generated sites. The changes enhance the user experience by providing clear, actionable steps for common customization needs.

Highlights

• New Documentation Page: A new documentation page, 'Custom Scripts', has been added to guide users on injecting custom scripts into their Docula sites.
• README Update: The main README file has been updated to include a link to the newly added 'Custom Scripts' documentation.
• Script Injection Methods: The new documentation details how to add scripts at the end of the body using includes/scripts.hbs and within the head using includes/header.hbs via partial template overrides.
• Local Script Hosting: Instructions are provided for self-hosting script files in the public/ folder and referencing them from template overrides.
• Dependency Cleanup: An unused import for DoculaChangelogEntry was removed from site/docula.config.ts.

Changelog

• README.md
  • Added a new entry for 'Custom Scripts' in the documentation table of contents.
• site/docs/custom-scripts.md
  • Created a new documentation file explaining how to add custom scripts to Docula.
  • Provided examples for adding scripts to the body and head sections.
  • Included guidance on locally hosting script files.
  • Added important notes regarding template overrides and template compatibility.
• site/docula.config.ts
  • Removed the unused import statement for DoculaChangelogEntry.

Activity

• The author has confirmed adherence to the Contributing and Code of Conduct guidelines.
• The author has indicated that tests for the changes have been added with 100% code coverage, which for a documentation feature implies thorough review and validation of the new content.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds new documentation on how to add custom scripts to a Docula site. The changes include adding a new documentation page, linking to it from the main README, and a minor cleanup of an unused import in the site configuration. The new documentation is clear and well-structured. I've suggested a minor formatting improvement to a code example for better readability.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (a71ac51) to head (eae9f2d).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #354   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            7         7           
  Lines         1574      1574           
  Branches       465       465           
=========================================
  Hits          1574      1574           

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