[FEAT] Add docs for the Website #835

abhilashreddysh · 2025-03-24T02:29:24Z

Fixes issue

Fixes #273

Changes proposed

Separate documentation page

Check List (Check all the applicable boxes)

My code follows the code style of this project.
My change requires changes to the documentation.
I have updated the documentation accordingly.
This PR does not contain plagiarized content.
The title of my pull request is a short description of the requested changes.

Screenshots

Note to reviewers

Added nextra as documentation in the current website

coderabbitai · 2025-03-24T02:29:31Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions

Yeah! You did it 🎉 Now, Relax 😉, Grab a drink ☕, and wait for the maintainers to check your contributions. Meanwhile, you can discuss on other issues and solve them 😀. Thank You 😃!

Meanwhile you can also discuss about the project in our Discord Server 😀

Website/app/docs/layout.jsx

Website/public/_pagefind/pagefind-highlight.js

Website/public/_pagefind/pagefind-ui.js

Website/public/_pagefind/pagefind.js

vercel · 2025-03-24T05:59:02Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
drifty	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 27, 2025 3:51pm

SaptarshiSarkar12 · 2025-03-24T06:10:20Z

@abhilashreddysh Please fix the build error. Probably the package/package-lock file is not right.

Logs

[11:29:15.319] Installing dependencies...
[11:29:16.794] npm warn ERESOLVE overriding peer dependency
[11:29:16.795] npm warn While resolving: @theguild/[email protected]
[11:29:16.795] npm warn Found: [email protected]
[11:29:16.795] npm warn node_modules/react
[11:29:16.796] npm warn   react@"^19.0.0" from the root project
[11:29:16.796] npm warn   25 more (@floating-ui/react, @floating-ui/react-dom, ...)
[11:29:16.796] npm warn
[11:29:16.796] npm warn Could not resolve dependency:
[11:29:16.796] npm warn peer react@"^18.2.0" from @theguild/[email protected]
[11:29:16.796] npm warn node_modules/nextra/node_modules/@theguild/remark-mermaid
[11:29:16.796] npm warn   @theguild/remark-mermaid@"^0.2.0" from [email protected]
[11:29:16.796] npm warn   node_modules/nextra
[11:29:16.796] npm warn
[11:29:16.797] npm warn Conflicting peer dependency: [email protected]
[11:29:16.797] npm warn node_modules/react
[11:29:16.797] npm warn   peer react@"^18.2.0" from @theguild/[email protected]
[11:29:16.797] npm warn   node_modules/nextra/node_modules/@theguild/remark-mermaid
[11:29:16.797] npm warn     @theguild/remark-mermaid@"^0.2.0" from [email protected]
[11:29:16.797] npm warn     node_modules/nextra
[11:29:27.339] 
[11:29:27.340] added 400 packages, removed 10 packages, and changed 27 packages in 12s
[11:29:27.341] 
[11:29:27.341] 331 packages are looking for funding
[11:29:27.341]   run `npm fund` for details
[11:29:27.402] Detected Next.js version: 15.2.3
[11:29:27.407] Running "npm run build"
[11:29:27.828] 
[11:29:27.829] > [email protected] build
[11:29:27.829] > next build
[11:29:27.829] 
[11:29:29.059]    Downloading swc package @next/swc-linux-x64-gnu... to /vercel/.cache/next-swc
[11:29:29.064]  ⚠ Found lockfile missing swc dependencies, run next locally to automatically patch
[11:29:30.396]    Downloading swc package @next/swc-linux-x64-musl... to /vercel/.cache/next-swc
[11:29:31.712]    ▲ Next.js 15.2.3
[11:29:31.713] 
[11:29:31.736]    Creating an optimized production build ...
[11:29:49.716] Failed to compile.
[11:29:49.717] 
[11:29:49.717] ./content/Contributing.md
[11:29:49.720] Error: Cannot find module '@napi-rs/simple-git-linux-x64-gnu'
[11:29:49.721] Require stack:
[11:29:49.721] - /vercel/path1/node_modules/@napi-rs/simple-git/index.js
[11:29:49.721]     at Function.<anonymous> (node:internal/modules/cjs/loader:1225:15)
[11:29:49.721]     at /vercel/path1/node_modules/next/dist/server/require-hook.js:55:36
[11:29:49.721]     at Function._load (node:internal/modules/cjs/loader:1055:27)
[11:29:49.722]     at TracingChannel.traceSync (node:diagnostics_channel:322:14)
[11:29:49.722]     at wrapModuleLoad (node:internal/modules/cjs/loader:220:24)
[11:29:49.722]     at Module.<anonymous> (node:internal/modules/cjs/loader:1311:12)
[11:29:49.722]     at mod.require (/vercel/path1/node_modules/next/dist/server/require-hook.js:65:28)
[11:29:49.722]     at require (node:internal/modules/helpers:136:16)
[11:29:49.722]     at Object.<anonymous> (/vercel/path1/node_modules/@napi-rs/simple-git/index.js:190:31)
[11:29:49.722]     at Module._compile (node:internal/modules/cjs/loader:1554:14)
[11:29:49.722] 
[11:29:49.723] Import trace for requested module:
[11:29:49.723] ./content/Contributing.md
[11:29:49.723] ./content/ sync ^\.\/.*.*$
[11:29:49.723] ./node_modules/nextra/dist/client/pages.js
[11:29:49.723] ./app/docs/[[...mdxPath]]/page.jsx
[11:29:49.723] 
[11:29:49.723] ./content/development/architecture.md
[11:29:49.723] Error: Cannot find module '@napi-rs/simple-git-linux-x64-gnu'
[11:29:49.723] Require stack:
[11:29:49.723] - /vercel/path1/node_modules/@napi-rs/simple-git/index.js
[11:29:49.724]     at Function.<anonymous> (node:internal/modules/cjs/loader:1225:15)
[11:29:49.724]     at /vercel/path1/node_modules/next/dist/server/require-hook.js:55:36
[11:29:49.725]     at Function._load (node:internal/modules/cjs/loader:1055:27)
[11:29:49.725]     at TracingChannel.traceSync (node:diagnostics_channel:322:14)
[11:29:49.726]     at wrapModuleLoad (node:internal/modules/cjs/loader:220:24)
[11:29:49.726]     at Module.<anonymous> (node:internal/modules/cjs/loader:1311:12)
[11:29:49.726]     at mod.require (/vercel/path1/node_modules/next/dist/server/require-hook.js:65:28)
[11:29:49.726]     at require (node:internal/modules/helpers:136:16)
[11:29:49.726]     at Object.<anonymous> (/vercel/path1/node_modules/@napi-rs/simple-git/index.js:190:31)
[11:29:49.726]     at Module._compile (node:internal/modules/cjs/loader:1554:14)
[11:29:49.727] 
[11:29:49.727] Import trace for requested module:
[11:29:49.727] ./content/development/architecture.md
[11:29:49.727] ./content/ sync ^\.\/.*.*$
[11:29:49.727] ./node_modules/nextra/dist/client/pages.js
[11:29:49.727] ./app/docs/[[...mdxPath]]/page.jsx
[11:29:49.728] 
[11:29:49.728] ./content/development/building-executables.mdx
[11:29:49.728] Error: Cannot find module '@napi-rs/simple-git-linux-x64-gnu'
[11:29:49.728] Require stack:
[11:29:49.728] - /vercel/path1/node_modules/@napi-rs/simple-git/index.js
[11:29:49.729]     at Function.<anonymous> (node:internal/modules/cjs/loader:1225:15)
[11:29:49.729]     at /vercel/path1/node_modules/next/dist/server/require-hook.js:55:36
[11:29:49.729]     at Function._load (node:internal/modules/cjs/loader:1055:27)
[11:29:49.729]     at TracingChannel.traceSync (node:diagnostics_channel:322:14)
[11:29:49.729]     at wrapModuleLoad (node:internal/modules/cjs/loader:220:24)
[11:29:49.729]     at Module.<anonymous> (node:internal/modules/cjs/loader:1311:12)
[11:29:49.730]     at mod.require (/vercel/path1/node_modules/next/dist/server/require-hook.js:65:28)
[11:29:49.730]     at require (node:internal/modules/helpers:136:16)
[11:29:49.730]     at Object.<anonymous> (/vercel/path1/node_modules/@napi-rs/simple-git/index.js:190:31)
[11:29:49.730]     at Module._compile (node:internal/modules/cjs/loader:1554:14)
[11:29:49.730] 
[11:29:49.731] Import trace for requested module:
[11:29:49.731] ./content/development/building-executables.mdx
[11:29:49.731] ./content/ sync ^\.\/.*.*$
[11:29:49.732] ./node_modules/nextra/dist/client/pages.js
[11:29:49.733] ./app/docs/[[...mdxPath]]/page.jsx
[11:29:49.733] 
[11:29:49.733] ./content/development/macOS-docker-build-instructions.md
[11:29:49.733] Error: Cannot find module '@napi-rs/simple-git-linux-x64-gnu'
[11:29:49.733] Require stack:
[11:29:49.733] - /vercel/path1/node_modules/@napi-rs/simple-git/index.js
[11:29:49.733]     at Function.<anonymous> (node:internal/modules/cjs/loader:1225:15)
[11:29:49.733]     at /vercel/path1/node_modules/next/dist/server/require-hook.js:55:36
[11:29:49.736]     at Function._load (node:internal/modules/cjs/loader:1055:27)
[11:29:49.737]     at TracingChannel.traceSync (node:diagnostics_channel:322:14)
[11:29:49.737]     at wrapModuleLoad (node:internal/modules/cjs/loader:220:24)
[11:29:49.737]     at Module.<anonymous> (node:internal/modules/cjs/loader:1311:12)
[11:29:49.737]     at mod.require (/vercel/path1/node_modules/next/dist/server/require-hook.js:65:28)
[11:29:49.737]     at require (node:internal/modules/helpers:136:16)
[11:29:49.737]     at Object.<anonymous> (/vercel/path1/node_modules/@napi-rs/simple-git/index.js:190:31)
[11:29:49.737]     at Module._compile (node:internal/modules/cjs/loader:1554:14)
[11:29:49.737] 
[11:29:49.737] Import trace for requested module:
[11:29:49.738] ./content/development/macOS-docker-build-instructions.md
[11:29:49.738] ./content/ sync ^\.\/.*.*$
[11:29:49.738] ./node_modules/nextra/dist/client/pages.js
[11:29:49.738] ./app/docs/[[...mdxPath]]/page.jsx
[11:29:49.738] 
[11:29:49.738] ./content/development/quickstart.mdx
[11:29:49.738] Error: Cannot find module '@napi-rs/simple-git-linux-x64-gnu'
[11:29:49.738] Require stack:
[11:29:49.739] - /vercel/path1/node_modules/@napi-rs/simple-git/index.js
[11:29:49.739]     at Function.<anonymous> (node:internal/modules/cjs/loader:1225:15)
[11:29:49.739]     at /vercel/path1/node_modules/next/dist/server/require-hook.js:55:36
[11:29:49.739]     at Function._load (node:internal/modules/cjs/loader:1055:27)
[11:29:49.739]     at TracingChannel.traceSync (node:diagnostics_channel:322:14)
[11:29:49.739]     at wrapModuleLoad (node:internal/modules/cjs/loader:220:24)
[11:29:49.739]     at Module.<anonymous> (node:internal/modules/cjs/loader:1311:12)
[11:29:49.739]     at mod.require (/vercel/path1/node_modules/next/dist/server/require-hook.js:65:28)
[11:29:49.739]     at require (node:internal/modules/helpers:136:16)
[11:29:49.740]     at Object.<anonymous> (/vercel/path1/node_modules/@napi-rs/simple-git/index.js:190:31)
[11:29:49.740]     at Module._compile (node:internal/modules/cjs/loader:1554:14)
[11:29:49.740] 
[11:29:49.740] Import trace for requested module:
[11:29:49.740] ./content/development/quickstart.mdx
[11:29:49.740] ./content/ sync ^\.\/.*.*$
[11:29:49.740] ./node_modules/nextra/dist/client/pages.js
[11:29:49.740] ./app/docs/[[...mdxPath]]/page.jsx
[11:29:49.740] 
[11:29:49.740] 
[11:29:49.743] > Build failed because of webpack errors
[11:29:49.793] Error: Command "npm run build" exited with 1

Signed-off-by: Abhilash Reddy S H <[email protected]>

Signed-off-by: Saptarshi Sarkar <[email protected]>

Signed-off-by: Abhilash Reddy S H <[email protected]>

Signed-off-by: Saptarshi Sarkar <[email protected]>

Signed-off-by: Abhilash Reddy S H <[email protected]>

…y Policy file Signed-off-by: Saptarshi Sarkar <[email protected]>

Signed-off-by: Saptarshi Sarkar <[email protected]>

…ibility Signed-off-by: Saptarshi Sarkar <[email protected]>

… to docs page instead of home page Signed-off-by: Saptarshi Sarkar <[email protected]>

This comment was marked as resolved.

Sign in to view

github-actions bot added documentation 📝 Issues/Pull Requests regarding documentation Website 🌐 Issues/Pull Requests regarding Website dependencies 📦️ Pull Requests that update dependencies npm 📦️ Pull Requests that update npm dependencies labels Mar 24, 2025

github-actions bot reviewed Mar 24, 2025

View reviewed changes

github-advanced-security bot found potential problems Mar 24, 2025

View reviewed changes

Website/app/docs/layout.jsx Fixed Show fixed Hide fixed

abhilashreddysh force-pushed the master branch from 664fab4 to 7d8a0b9 Compare March 24, 2025 02:37

github-actions bot added CI/CD 🔁 Pull Requests which update GitHub Actions code maven 📦️ Pull Requests that update Maven dependencies labels Mar 24, 2025

This comment was marked as resolved.

Sign in to view

abhilashreddysh force-pushed the master branch from 063fd97 to d6b5056 Compare March 24, 2025 02:46

This comment was marked as resolved.

Sign in to view

abhilashreddysh force-pushed the master branch from 18094a2 to c07f006 Compare March 24, 2025 03:12

This comment was marked as resolved.

Sign in to view

github-actions bot removed CI/CD 🔁 Pull Requests which update GitHub Actions code maven 📦️ Pull Requests that update Maven dependencies labels Mar 24, 2025

github-advanced-security bot found potential problems Mar 24, 2025

View reviewed changes

coderabbitai bot approved these changes Mar 24, 2025

View reviewed changes

vercel bot had a problem deploying to Preview March 24, 2025 05:59 Failure

vercel bot deployed to Preview March 24, 2025 08:17 View deployment

This comment was marked as resolved.

Sign in to view

vercel bot deployed to Preview March 24, 2025 12:34 View deployment

SaptarshiSarkar12 marked this pull request as draft March 24, 2025 17:36

github-actions bot removed the maven 📦️ Pull Requests that update Maven dependencies label Mar 25, 2025

style: format codebase

bd59d94

This comment was marked as resolved.

Sign in to view

abhilashreddysh added 2 commits March 25, 2025 09:20

fix: Fix Linting errors

a8ba61c

Signed-off-by: Abhilash Reddy S H <[email protected]>

Merge branch 'master' of https://github.com/abhilashreddysh/Drifty

47b6559

vercel bot had a problem deploying to Preview March 25, 2025 04:04 Failure

fix: build issues

6c511c3

Signed-off-by: Abhilash Reddy S H <[email protected]>

vercel bot had a problem deploying to Preview March 25, 2025 04:13 Failure

SaptarshiSarkar12 and others added 2 commits March 25, 2025 10:16

fix: Fixed build error

b272df3

Signed-off-by: Saptarshi Sarkar <[email protected]>

fix: Add dark mode support for demo popup window

211222c

Signed-off-by: Abhilash Reddy S H <[email protected]>

vercel bot deployed to Preview March 25, 2025 04:52 View deployment

SaptarshiSarkar12 and others added 2 commits March 25, 2025 10:56

chore(deps): updated next and eslint-config-next

e44ee36

Signed-off-by: Saptarshi Sarkar <[email protected]>

chore(docs): Update content as per old docs

df78b04

Signed-off-by: Abhilash Reddy S H <[email protected]>

vercel bot deployed to Preview March 25, 2025 08:31 View deployment

SaptarshiSarkar12 and others added 2 commits March 26, 2025 09:01

docs: Upgraded JDK version in docs and updated website URLs in Privac…

c8d1197

…y Policy file Signed-off-by: Saptarshi Sarkar <[email protected]>

style: format codebase

d5569d4

vercel bot had a problem deploying to Preview March 26, 2025 03:33 Failure

This comment was marked as resolved.

Sign in to view

SaptarshiSarkar12 added 4 commits March 26, 2025 09:34

docs: Fixed formatting and build issues

0137e79

Signed-off-by: Saptarshi Sarkar <[email protected]>

docs: Fixed formatting issues

b0b01f1

Signed-off-by: Saptarshi Sarkar <[email protected]>

docs: Fixed formatting issues

d796b39

Signed-off-by: Saptarshi Sarkar <[email protected]>

chore: Updated GraalVM links to direct download links provided by Oracle

7736ba0

Signed-off-by: Saptarshi Sarkar <[email protected]>

vercel bot deployed to Preview March 26, 2025 04:59 View deployment

SaptarshiSarkar12 added 2 commits March 26, 2025 10:40

chore: Fixed a minor formatting issue

1070657

Signed-off-by: Saptarshi Sarkar <[email protected]>

chore: Fixed transparency of images for better readability and access…

26c19cc

…ibility Signed-off-by: Saptarshi Sarkar <[email protected]>

vercel bot deployed to Preview March 26, 2025 07:20 View deployment

Merge branch 'master' into master

6bbb0a2

vercel bot deployed to Preview March 27, 2025 15:38 View deployment

chore: Changed hyperlink in "Drifty Docs" heading in nav bar to point…

34edfac

… to docs page instead of home page Signed-off-by: Saptarshi Sarkar <[email protected]>

vercel bot deployed to Preview March 27, 2025 15:51 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FEAT] Add docs for the Website #835

[FEAT] Add docs for the Website #835

abhilashreddysh commented Mar 24, 2025 •

edited by SaptarshiSarkar12

Loading

This comment was marked as resolved.

coderabbitai bot commented Mar 24, 2025 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot left a comment

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

vercel bot commented Mar 24, 2025 •

edited

Loading

SaptarshiSarkar12 commented Mar 24, 2025

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

[FEAT] Add docs for the Website #835

Are you sure you want to change the base?

[FEAT] Add docs for the Website #835

Conversation

abhilashreddysh commented Mar 24, 2025 • edited by SaptarshiSarkar12 Loading

Fixes issue

Changes proposed

Check List (Check all the applicable boxes)

Screenshots

Note to reviewers

This comment was marked as resolved.

coderabbitai bot commented Mar 24, 2025 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

github-actions bot left a comment

Choose a reason for hiding this comment

Yeah! You did it 🎉 Now, Relax 😉, Grab a drink ☕, and wait for the maintainers to check your contributions. Meanwhile, you can discuss on other issues and solve them 😀. Thank You 😃!

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

vercel bot commented Mar 24, 2025 • edited Loading

SaptarshiSarkar12 commented Mar 24, 2025

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

abhilashreddysh commented Mar 24, 2025 •

edited by SaptarshiSarkar12

Loading

coderabbitai bot commented Mar 24, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

vercel bot commented Mar 24, 2025 •

edited

Loading