Skip to content

Comments

docs: update links and README#8

Merged
Pertempto merged 3 commits intomainfrom
2025-11-18-updates
Nov 18, 2025
Merged

docs: update links and README#8
Pertempto merged 3 commits intomainfrom
2025-11-18-updates

Conversation

@Pertempto
Copy link
Contributor

No description provided.

@Pertempto Pertempto self-assigned this Nov 18, 2025
@Pertempto Pertempto requested a review from bambam955 November 18, 2025 16:33
@github-actions
Copy link

README.md: You removed the template content and left just the site link. Is that intentional? If you want to keep the README minimal that's fine, but please either:

  • Add a short "Run locally" or "Contributing" section (commands like npm install, npm run dev) or
  • Link to a central contributing docs page (e.g. CONTRIBUTING.md or a docs site).

This will help external contributors and maintainers quickly run or contribute to the site.

@github-actions
Copy link

src/content/docs/index.mdx: I noticed you re-ordered and added links under "Open Source Projects" and updated some doc site hostnames. Two quick checks:

  • Confirm LinkCard import supports the same props and ordering — behaviorally it's fine, but ensure no layout regressions occur from reordering.
  • For MConn you changed the host to https://mconn.mrs-electronics.dev. Make sure DNS and hosting are configured and the certificate covers the subdomain.

If you want, I can verify the built site for broken links if CI artifacts or a preview URL are available.

@github-actions
Copy link

github-actions bot commented Nov 18, 2025

Changes Requested

Please address the items below before merging.

  • Restore a minimal "Getting started" section in README.md (install/build/dev commands) or add a one-line project description if the shortened README is intentional.
  • Confirm the link change in src/content/docs/index.mdx for MConn now pointing to https://mconn.mrs-electronics.dev is intentional and reachable; if this is an internal subdomain, consider whether a docs subpath or canonical domain should be used instead.
  • Confirm the new android-automotive link addition in src/content/docs/index.mdx is intended and not a duplicate entry; ensure ordering/labels are correct.

Summary of Changes

  • README.md simplified to a single link to the live site.
  • src/content/docs/index.mdx updated: added android-automotive link, reordered bots, and changed the MConn link to https://mconn.mrs-electronics.dev.

Overall Feedback

  • Negative: The README replacement removed basic contributor/dev instructions which will confuse new contributors and slow local development. Please restore minimal setup commands or a clear note about the repo purpose.
  • Positive: The site-linking and documentation cards updates look intentional and help point visitors to active projects and docs. Thanks for tidying these links — nice cleanup! 🚀🙂

@github-actions
Copy link

@Pertempto — I reviewed README.md (current contents shown). It was replaced with a single link. Please either:

  • Restore a minimal "Getting started" section with basic commands (npm install, npm run dev, npm run build) and a short repo description; or
  • Confirm the minimal README is intentional and add a one-line project description explaining what this repo/site is for.

This avoids confusing contributors who expect basic dev instructions.

Copy link
Contributor

@bambam955 bambam955 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Code review bot, we don't need anything else in the README...this isn't meant to have contributors outside of our organization.

Updating the link to the MConn docs was a good move 👍

@bambam955
Copy link
Contributor

@Pertempto merge when ready

@Pertempto Pertempto merged commit d9a7540 into main Nov 18, 2025
1 check failed
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