Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Improve Extension Development Documentation #4424

Closed
imtuyethan opened this issue Jan 9, 2025 · 0 comments · Fixed by #4461
Closed

docs: Improve Extension Development Documentation #4424

imtuyethan opened this issue Jan 9, 2025 · 0 comments · Fixed by #4461
Assignees
Labels
type: docs Improvements or additions to documentation
Milestone

Comments

@imtuyethan
Copy link
Contributor

imtuyethan commented Jan 9, 2025

Problem Statement

https://discord.com/channels/1107178041848909847/1326294926622986282

Developers attempting to create extensions for Jan are facing challenges understanding:

  • The core tech stack (Electron + Next.js)
  • How to properly implement node.js libraries and handle server-side vs client-side code
  • The model provider system and extension integration
  • Proper redirect URL configuration for OAuth implementations
  • Deep linking and URL handling in the Electron environment

Feature Idea

Create comprehensive extension development documentation that includes:

  • Clear overview of Jan's tech stack architecture (Electron + Next.js)
  • Guide for handling OAuth and authentication in extensions
  • Best practices for using node.js libraries in the Electron context
  • Tutorial on implementing model providers
  • Examples of common extension patterns
  • Troubleshooting section addressing common errors (like the require issue mentioned)
  • Documentation on app deep linking and URL handling

The documentation should be beginner-friendly and include practical examples, as we're seeing developers struggle with fundamental concepts when trying to create extensions.

The primary goal is to reduce confusion and enable developers to successfully create extensions without running into basic architectural misunderstandings.

@imtuyethan imtuyethan added the type: feature request A new feature label Jan 9, 2025
@github-project-automation github-project-automation bot moved this to Investigating in Menlo Jan 9, 2025
@imtuyethan imtuyethan added type: docs Improvements or additions to documentation and removed type: feature request A new feature labels Jan 9, 2025
@imtuyethan imtuyethan self-assigned this Jan 9, 2025
@imtuyethan imtuyethan moved this from Investigating to Scheduled in Menlo Jan 9, 2025
@imtuyethan imtuyethan added this to the v0.5.14 milestone Jan 13, 2025
@github-project-automation github-project-automation bot moved this from Scheduled to QA in Menlo Jan 16, 2025
@imtuyethan imtuyethan moved this from QA to Completed in Menlo Jan 16, 2025
@imtuyethan imtuyethan modified the milestones: v0.5.14, v0.5.15 Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvements or additions to documentation
Projects
Status: Completed
Development

Successfully merging a pull request may close this issue.

1 participant