Skip to content

chore: upgrading docual and marked#442

Merged
jaredwray merged 1 commit intomainfrom
chore-upgrading-docual-and-marked
Mar 27, 2026
Merged

chore: upgrading docual and marked#442
jaredwray merged 1 commit intomainfrom
chore-upgrading-docual-and-marked

Conversation

@jaredwray
Copy link
Copy Markdown
Owner

@jaredwray jaredwray commented Mar 27, 2026

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, ...)
chore: upgrading docual and marked

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 27, 2026

Codecov Report

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

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #442   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            5         5           
  Lines          470       470           
  Branches       107       107           
=========================================
  Hits           470       470           

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

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request upgrades the docula and marked dependencies and updates the website configuration to include theme support and AI integration via Anthropic. Documentation in the README was also updated to escape HTML tags for proper rendering. Feedback was provided to safely handle the ANTHROPIC_API_KEY environment variable by avoiding non-null assertions to prevent potential runtime errors.

Comment on lines +15 to +18
ai: {
provider: 'anthropic',
apiKey: process.env.ANTHROPIC_API_KEY!,
},
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.

high

Using a non-null assertion ! for an environment variable is risky. If ANTHROPIC_API_KEY is not set at runtime, apiKey will be undefined, which could lead to downstream errors. It's safer to conditionally define the ai configuration based on the presence of the API key. This makes the AI feature optional and prevents runtime errors if the key is missing.

Suggested change
ai: {
provider: 'anthropic',
apiKey: process.env.ANTHROPIC_API_KEY!,
},
ai: process.env.ANTHROPIC_API_KEY ? {
provider: 'anthropic',
apiKey: process.env.ANTHROPIC_API_KEY,
} : undefined,

@jaredwray jaredwray merged commit 38b3759 into main Mar 27, 2026
11 checks passed
@jaredwray jaredwray deleted the chore-upgrading-docual-and-marked branch March 27, 2026 02:59
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 79eca0260f

ℹ️ 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".

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.

1 participant