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

Re-running yarn start with un-committed changes removes those changes #890

Closed
josh-padnick opened this issue Jun 16, 2023 · 3 comments
Closed

Comments

@josh-padnick
Copy link
Contributor

Here's how to reproduce:

  1. Run yarn start
  2. Update a doc. The changes are reflected in the locally running version as expected.
  3. Do not commit those changes to git.
  4. CTRL-C
  5. Re-run yarn start

The changes from (2) now disappear. This bit me hard when I restarted yarn start without committing my changes. I was only able to recover them from my IDE's memory.

@josh-padnick
Copy link
Contributor Author

@eak12913 Any thought on this one?

@eak12913
Copy link
Contributor

Where did you make changes? Recall that the 'docs-sourcer' runs on each save and also on each restart. If you changed a file in the /docs/.... folder instead of changing it in _docs-sources/.... then it would get blown away when the restart happened because you would have updated a "generated" version of the file rather than updating its source.

@josh-padnick
Copy link
Contributor Author

Ah...that was the issue. Uh oh, I'm now realizing I need to check my past PRs to make sure I didn't commit changes only to generated files. Maybe the real change here is just updating the docs to clarify in which folder to write new docs.

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

No branches or pull requests

3 participants