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

Add HOWTOs to the docs site #779

Open
ambroseus opened this issue Jul 20, 2020 · 5 comments
Open

Add HOWTOs to the docs site #779

ambroseus opened this issue Jul 20, 2020 · 5 comments
Labels
scope: docs Documentation could be improved. Or changes that only affect docs

Comments

@ambroseus
Copy link
Contributor

ambroseus commented Jul 20, 2020

Add HOWTOs #379
to the Customization section of the docs site #379 (comment)

@ambroseus
Copy link
Contributor Author

let's do it)

@ambroseus ambroseus changed the title Add HOWTOs to the website Add HOWTOs to the docs site Jul 20, 2020
@agilgur5 agilgur5 added the scope: docs Documentation could be improved. Or changes that only affect docs label Jul 26, 2020
@agilgur5
Copy link
Collaborator

I'm not sure if Customization is the right section as those are very specific use-cases. I think it would be better in a section called HOWTOs. Crazy name, I know 😆 . Customization could link to that.

That being said, I'm still wary of doing so as:

  • Nearly all of them are tsdx.config.js uses, which are super brittle per the warning. Things like (fix): multiple entries should output multiple bundles #367 that change Rollup's output.file to output.dir, which is normally internal-only, are now breaking changes due to this exposure 😕 . Making them "official" can exacerbate this
  • Not all of them have been verified, like the "local dev" one there should be a way of doing it normally.
  • [RFC] Shareable Plugins (for TSDX Build/Config, i.e. tsdx.config.js or Rollup in general) #635 should theoretically solve the issues in a testable and more easily shareable manner, though the kinks still have to be ironed out there on what the API would look like and what the "core plugins" would be (at minimum, they'd be the ones I've already written integration tests for due to their frequent usage)

@ambroseus
Copy link
Contributor Author

@agilgur5 yep, need to revise and recheck each of HOWTO's approach

@shadiramadan
Copy link

Were you able to look these over again @ambroseus ?

@ambroseus
Copy link
Contributor Author

@shadiramadan as soon as possible :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: docs Documentation could be improved. Or changes that only affect docs
Projects
None yet
Development

No branches or pull requests

3 participants