fix: the output path should be in the sitePath like cache is

[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, ...)
fix: the output path should be in the sitePath like cache is

[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 refines the default behavior for the output directory, ensuring it is consistently placed relative to the sitePath. This change standardizes how build artifacts are organized, making the project configuration more intuitive and predictable for users by aligning the output location with other site-specific content.

Highlights

• Output Path Default: The default output directory for built sites now resides within the sitePath (e.g., sitePath/dist) instead of directly in the current working directory.
• Configuration Logic Update: The DoculaOptions class in src/options.ts was updated to implement this new default behavior for the output property.
• Documentation Alignment: The documentation in site/docs/configuration.md has been updated to reflect the new default output path and its description.

Changelog

• site/docs/configuration.md
  • Updated the example output path from ./dist to ./site/dist.
  • Modified the default value description for the output option in the configuration table to '{sitePath}/dist'.
• src/options.ts
  • Removed the absolute default path initialization for the output property.
  • Added logic within the constructor to set the output path to path.join(this.sitePath, 'dist') if no custom output path is provided.

Activity

• No activity has been recorded for this pull request yet.

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 aims to change the default output directory to be inside the sitePath. The implementation in src/options.ts and the documentation changes in site/docs/configuration.md look correct and achieve this goal.

However, there are a couple of issues that should be addressed:

1. Missing Test Updates: The tests for DoculaOptions have not been updated to reflect the new default behavior for the output path. The PR description claims that tests have been added, but they are missing from the file changes. It's crucial to have tests for this logic to prevent regressions. I've added a specific comment on src/options.ts about this.

2. Inconsistent Initial Configuration: The files used by the docula init command (init/docula.config.ts and init/docula.config.mjs) still specify output: './dist'. This will override the new default behavior and place the output directory at the project root, which is inconsistent with the goal of this PR. The best approach would be to remove the output property from these initial configuration files, allowing the new default logic to apply automatically.

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 5230ce0a82

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.94%. Comparing base (79f9cca) to head (3eec3d2).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #359   +/-   ##
=======================================
  Coverage   99.94%   99.94%           
=======================================
  Files           7        7           
  Lines        1788     1796    +8     
  Branches      514      524   +10     
=======================================
+ Hits         1787     1795    +8     
  Misses          1        1           

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