Skip to content

Conversation

rokubop
Copy link

@rokubop rokubop commented Jun 27, 2025

  • Add repository explorer which caches repo results from GitHub tagged with talonvoice.

    • Will prefer cached, build-time results to avoid hitting GitHub API limit per hour
    • Add npm run update-repos command, which will update the repo list
    • Add node-fetch package
    • Add cross-env package
  • Consolidate and update README.md

  • Recommend forking for contributions

image
image
image

Copy link

netlify bot commented Jun 27, 2025

Deploy Preview for talon-wiki-refactor ready!

Name Link
🔨 Latest commit b87dee9
🔍 Latest deploy log https://app.netlify.com/projects/talon-wiki-refactor/deploys/685dfdf83fa9b40008145fea
😎 Deploy Preview https://deploy-preview-328--talon-wiki-refactor.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@oogen925
Copy link

Love the more robust development info! It is helpful for someone like me who is not super well versed in git/npm

@splondike
Copy link
Contributor

Making the contribution changes more explicit looks good to me.

For the repo explorer potentially somebody will want to move the repo explorer underneath the Integrations header at some point because it probably fits better there. I am happy to give it pride of place in the top menu for a bit though because it's fun and you've put a lot of work in I can see ;). I think we should leave this PR open for maybe another week before merging though to give anybody else a chance to comment.

A couple of points and questions about the repo explorer:

  • We build the data for the repo explorer at compile time on Netlify into the .js. If the Github API blocks us sometimes, hopefully we'll have a cached repo list on Netlify for the code to use (I don't know if they provide this service)? But if not, some deployments may have no content in the explorer. E.g. if the Netlify build servers (shared amongst all their customers) make too many requests to Github in a short period. The solution as implemented in this code is to somehow provide a Github access token to Netlify.
  • For the older web devs out there, the CSS classes may look a bit too unscoped, but it's actually a 'CSS in JS' pattern where the names get mutated in the final rendering to make them unique to the component.

@rokubop
Copy link
Author

rokubop commented Jun 30, 2025

Sounds good. We can let this PR brew, for others to consider the changes / any feedback.

Some notes:

  • I did initially implement this under "Integrations", but I noticed because of the sidebar, the main body had limited room to display the cards - only 2-3 across. With a dedicated full width view however, I like that it can display up to 4 columns and you can see more at once.
  • Github token can be used, but it's not a requirement. The data is compiled at build time into a json file, so when you actually visit the site, it's just reading the json file, no API calls.
  • Yes exactly about the CSS - that *.module.css pattern is scoped to just the files that use it.

@splondike
Copy link
Contributor

Well, people have had their week 2 months (sorry, this slipped my mind). The site is now hosted on Github pages with Netlify just used for previews. The CI config looks simple enough that I imagine your functionality will still work.

When you have the time, would you be able to rebase this on the latest main branch? After that we can merge it in and confirm it works.

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.

3 participants