Skip to content

Conversation

theletterf
Copy link
Contributor

Fixes #1466

Notice that the preview process is now left last, as we want to encourage local docs builds and error checking.

@theletterf theletterf requested a review from a team as a code owner June 30, 2025 09:31
@theletterf theletterf self-assigned this Jun 30, 2025
@theletterf theletterf added the documentation Improvements or additions to documentation label Jun 30, 2025
@theletterf theletterf requested a review from reakaleek June 30, 2025 09:31
@theletterf
Copy link
Contributor Author

Build errors — ironic! :D I'll fix those now. Also the whitespace anomalies if I can.

@theletterf theletterf enabled auto-merge (squash) June 30, 2025 09:43
@theletterf theletterf merged commit 6945015 into main Jun 30, 2025
15 checks passed
@theletterf theletterf deleted the add-error-build-instructions branch June 30, 2025 09:48
@colleenmcginnis
Copy link
Contributor

colleenmcginnis commented Jun 30, 2025

Notice that the preview process is now left last, as we want to encourage local docs builds and error checking.

I'm not sure that I agree with this. I think it is valuable to run the preview while writing so contributors can see the changes they're making. Then the can check for build errors before committing/pushing to GitHub. 🤔

@theletterf
Copy link
Contributor Author

@colleenmcginnis OTOH we're still keeping serve in the install step, so they know about it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] Document how to check for build errors locally
3 participants