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

Fix documentation errors #2281

Open
wants to merge 2 commits into
base: release
Choose a base branch
from

Conversation

piffio
Copy link

@piffio piffio commented Sep 14, 2024

Description

I was going through the documentation and found some minor issues.

  1. One typo
  2. In some cases, the Typescript code referenced js files rather than ts ones.

Hope this helps

Select what type of change this PR introduces:

  1. Just code/docs improvement (no functional change).
  2. Bug fix (non-breaking change which fixes an issue).
  3. New feature (non-breaking change which adds functionality).
  4. Breaking change (fix or feature that would cause existing functionality to not work as expected).

Update Waspc ChangeLog and version if needed

If you did a bug fix, new feature, or breaking change, that affects waspc, make sure you satisfy the following:

  1. I updated ChangeLog.md with description of the change this PR introduces.
  2. I bumped waspc version in waspc.cabal to reflect changes I introduced, with regards to the version of the latest wasp release, if the bump was needed.

Update example apps if needed

If you did code changes and added a new feature or modified an existing feature, make sure you satisfy the following:

  1. I updated waspc/examples/todoApp as needed (updated modified feature or added new feature) and manually checked it works correctly.
  2. I updated waspc/headless-test/examples/todoApp and its e2e tests as needed (updated modified feature and its tests or added new feature and new tests for it).

@sodic
Copy link
Contributor

sodic commented Sep 17, 2024

Hey @piffio, thanks for the contribution!

While this is the mistake, it's unfortunately not the right fix. The files should actually have no extension for both js and ts (like we show in the tutorial).

Can you fix this?

@sodic sodic self-assigned this Sep 17, 2024
@piffio
Copy link
Author

piffio commented Sep 18, 2024

Sure, thanks for the heads up @sodic . I'll take a look at it during the weekend and update the PR!

@sodic
Copy link
Contributor

sodic commented Oct 16, 2024

Hey @piffio, any updates on this? Do you want me to take it off your hands?

@piffio
Copy link
Author

piffio commented Oct 18, 2024

Hello @sodic ,

Sorry for being late on this one, but I've been busy building stuff with Wasp :)
Leave it with me for a few more days, and I'll prepare an updated PR.

Thanks for your patience!

@sodic
Copy link
Contributor

sodic commented Oct 24, 2024

Sure @piffio, thanks!

@sodic
Copy link
Contributor

sodic commented Nov 14, 2024

Hey @piffio, since we'd like to get this fix out as soon as possible, I was wondering whether you'll have time to finish it this week or should I take over?

If you can't spare the time - no problem at all! Don't feel pressured into having to do anything.

I just wanted to let you know what's up before I "take away" your contribution :)

@piffio
Copy link
Author

piffio commented Nov 14, 2024

Hey @sodic , thanks for the follow-up.

In fact I have switched my focus on other topics lately and I won't likely be back on wasp for a couple of weeks at least.
So please go ahead, and sorry for keeping you waiting here.

Cheers

@sodic
Copy link
Contributor

sodic commented Nov 14, 2024

Thanks for the fast reply!

No problem, I know how these things go :)

Ok then, I'll take it off your hands.

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.

2 participants