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

third party extension doc(v0.1) #84

Merged
merged 16 commits into from
Jul 25, 2024
Merged

Conversation

technophile-04
Copy link
Collaborator

Description:

Tried writing very basic doc for creating third party extension with phase 1 & 2. Lol I think it could way better / improved.

@rin-st
Copy link
Member

rin-st commented Jul 18, 2024

Thanks Shiv, good starting point! Added some small comments

Also, I think pr should be into developer-extension-v0.2 since yarn create-extension is not in the main branch yet

Copy link
Member

@carletex carletex left a comment

Choose a reason for hiding this comment

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

This is a great start, thank you @technophile-04 !!

Left some comments.. .mosty about context (sorry, I think I said that word a lot haha)

contributors/THIRD-PARTY-EXTENSION.md Outdated Show resolved Hide resolved
contributors/THIRD-PARTY-EXTENSION.md Show resolved Hide resolved
contributors/THIRD-PARTY-EXTENSION.md Show resolved Hide resolved
contributors/THIRD-PARTY-EXTENSION.md Show resolved Hide resolved
contributors/THIRD-PARTY-EXTENSION.md Outdated Show resolved Hide resolved
contributors/THIRD-PARTY-EXTENSION.md Outdated Show resolved Hide resolved
@technophile-04 technophile-04 changed the base branch from main to developer-extension-v0.2 July 18, 2024 14:57
@technophile-04
Copy link
Collaborator Author

Tysm all for great feedback!! Update with suggested not sure if its on point, but please feel free to suggest change / push tweaks!!

@technophile-04 technophile-04 changed the base branch from developer-extension-v0.2 to main July 18, 2024 15:01
@technophile-04 technophile-04 changed the base branch from main to developer-extension-v0.2 July 18, 2024 15:02
@MattPereira
Copy link

This is REALLY DOPE idea ya'll are working on here!!! 👾 ❤️ 👾

The DX may be a little harder but you gain EZ mode for keeping a build up to date with the latest version of scaffold 🤯

I think the biggest hurdle will be getting devs to understand the caveats for what is or is not allowed

Obviously I don't understand all the nuances of whats possible or should be allowed , but I kinda wish there was a way to just overwrite some of the base instance files completely to allow for control of stuff like the order of navbar links and running fully customized versions of the home page, tailwind.config.js, and the footer component w/o the price fetching overhead

However, THIS IS STILL ABSOLUTELY AMAZING 💪 🚀 🌕

@technophile-04
Copy link
Collaborator Author

technophile-04 commented Jul 22, 2024

Thanks Matt for the review!! Yes the best thing about extension is that you always get up-to-date version of SE-2 for any extension(since people are not allowed to change base things)

I think the biggest hurdle will be getting devs to understand the caveats for what is or is not allowed

yes 100%, we are still figuring out what are the best way to tackle it. #73 logs this nicely while developing the extension but we could also refine this document more with further iterations/feedback

Obviously I don't understand all the nuances of whats possible or should be allowed , but I kinda wish there was a way to just overwrite some of the base instance files completely to allow for control of stuff like the order of navbar links and running fully customized versions of the home page, tailwind.config.js, and the footer component w/o the price fetching overhead

Yup I get you, but allowing people to override base instance files will again led to extension creators needing to keep their version up to date + we don't know if they unintentionally change something which breaks the resultant "instance" completely and hard to debug. But yup completely get you and maybe allowing certain files makes sense, somethings we need to discuss/refine as we get more and more feedback.

Base automatically changed from developer-extension-v0.2 to main July 23, 2024 08:19
@rin-st
Copy link
Member

rin-st commented Jul 24, 2024

I've run it through a spell checker and it found some (very minor) additional typos. Please recheck if everything is right. e098210

Other than that, lgtm! Great job!

Copy link
Member

@carletex carletex left a comment

Choose a reason for hiding this comment

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

I think this is a good merge. We can tinker as we go.

I'd personally clarify that all of this workflow might not be needed at all (if you are doing something simple) to avoid scaring builders haha More in this comment

But let's also see how it feels for other people.

Copy link
Collaborator Author

@technophile-04 technophile-04 left a comment

Choose a reason for hiding this comment

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

Thanks all !! Merging this for now, but also created #87 (which I think we should tackle before being loud with general people and opening it for all)

@technophile-04 technophile-04 merged commit 0b28a10 into main Jul 25, 2024
1 check passed
@technophile-04 technophile-04 deleted the third-party-extension-doc-v0.1 branch July 25, 2024 13:56
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.

5 participants