Skip to content

Conversation

@x753
Copy link
Contributor

@x753 x753 commented Apr 7, 2025

@MythicManiac
Copy link
Member

I'd like to keep the package docs coupled with the actual implementation, which is why they've been maintained in the same repo / in-project until now. This breaks that, wiki could more easily end up with wrong/different content (and it's non-obvious at which point and by who should it be updated when things change.)

So while I'm not strictly against this change, I'd like to ensure the above is actually fully taken into consideration somehow & we don't run into a situation where the documentation is outdated or inaccessible

@x753
Copy link
Contributor Author

x753 commented Apr 15, 2025

I'd like to keep the package docs coupled with the actual implementation, which is why they've been maintained in the same repo / in-project until now. This breaks that, wiki could more easily end up with wrong/different content (and it's non-obvious at which point and by who should it be updated when things change.)

I'll take on the task of keeping the wiki up to date. I see the wiki as a better option to keep documentation from being outdated, as I don't see anything stopping us from forgetting to update the seldom used package docs page, and in the event that we do forget it, updating it would require a deployment whereas the wiki could be updated immediately.

Redirect package docs to wiki
@codecov
Copy link

codecov bot commented Jun 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.22%. Comparing base (007e4a6) to head (57fb719).
Report is 208 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1137      +/-   ##
==========================================
+ Coverage   92.85%   93.22%   +0.36%     
==========================================
  Files         315      330      +15     
  Lines        9271    10058     +787     
  Branches      831      934     +103     
==========================================
+ Hits         8609     9377     +768     
- Misses        545      557      +12     
- Partials      117      124       +7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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