Skip to content

fix: missing items#3

Merged
Pertempto merged 4 commits intomainfrom
ae-fix-readme
Nov 4, 2025
Merged

fix: missing items#3
Pertempto merged 4 commits intomainfrom
ae-fix-readme

Conversation

@Pertempto
Copy link
Contributor

@Pertempto Pertempto commented Nov 4, 2025

  • Fixed incorrect info in the README
  • Added missing deploy workflow
  • Add name to package.json

@Pertempto Pertempto self-assigned this Nov 4, 2025
@Pertempto Pertempto requested a review from bambam955 November 4, 2025 14:23
@github-actions
Copy link

github-actions bot commented Nov 4, 2025

@Pertempto Quick check: You changed the build output in the README to dist/. Please confirm the repo/build config actually outputs to dist/ (check astro.config.mjs, vite.config.*, or package.json scripts). If the project outputs to public/, revert this change or update the build config. Action: either update README to match config or update config to match README.

@github-actions
Copy link

github-actions bot commented Nov 4, 2025

Changes Requested

  • Revert or fix package.json and package-lock.json name fields to a valid npm package name (e.g. docs-template) or remove name (keep private: true). Ensure package-lock.json matches.
  • Confirm and fix the build output directory mismatch: either change README.md back to ./public/ or update the build config so the build actually writes to dist/. In your PR description or commits, show which file(s) you updated (astro.config.mjs, vite.config.*, or package.json scripts).

Summary of Changes

  • Added GitHub Actions workflow: /.github/workflows/deploy.yaml to deploy to GitHub Pages.
  • Updated README.md:
    • Reordered checklist (moved "Enable "Enforce HTTPS"" below deployment verification).
    • Replaced static/ with public/ for static assets.
    • Changed documented build output from ./public/ to dist/.
  • Modified package.json and package-lock.json name fields to Docs Template (capitalized, with spaces).

Overall Feedback

  • Critical issues first: the name change in package.json/package-lock.json and the README's dist/ build directory are both risky and can break CI/publishing/deployments. Please fix these before merging.

  • Positive: adding a Pages deploy workflow and clarifying the README checklist improves onboarding and makes the template easier to use. Nice cleanup!

Please address the two requested fixes and reply here with which files you changed so I can re-check quickly. @Pertempto

@Pertempto Pertempto changed the title fix: paths in README fix: README info Nov 4, 2025
@Pertempto
Copy link
Contributor Author

Keeping this as draft until we have mconn-docs deployed and I'm confident in the steps.

@bambam955
Copy link

Keeping this as draft until we have mconn-docs deployed and I'm confident in the steps.

Got it. Let me know when it's ready 🫡

@Pertempto
Copy link
Contributor Author

Well I already missed one thing ☹️ i was SURE i added the deploy workflow earlier but it must not have saved or something

@Pertempto Pertempto changed the title fix: README info fix: missing items Nov 4, 2025
@Pertempto Pertempto marked this pull request as ready for review November 4, 2025 15:05
@Pertempto
Copy link
Contributor Author

should be good now

@bambam955
Copy link

Well I already missed one thing ☹️ i was SURE i added the deploy workflow earlier but it must not have saved or something

I wondered about that but assumed you were saving it for a separate PR because the title of #1 was only about Astro 😅 oh well

@Pertempto Pertempto merged commit c6abb7c into main Nov 4, 2025
1 check passed
@Pertempto Pertempto deleted the ae-fix-readme branch November 4, 2025 15:09
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