-
Notifications
You must be signed in to change notification settings - Fork 263
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix/readme banners #523
Fix/readme banners #523
Conversation
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
This reverts commit c46b464.
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
This reverts commit c8b8f93.
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
This reverts commit 27edc59.
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
I feel like I prefer the relative path, which makes it resilient against branch name changing, merge conflicts, parent directory renaming ...etc. I feel like this is a problem that should be addressed downstream where the script that generates the docs for the README, should rewrite the relative URL to a permanent URL that reference the commit it was generated from. |
How do other downstreams like docs.rs and npm handle this? I can look into what it would take to match whatever they're doing. I'd just copied what's done here: https://github.com/tauri-apps/tauri/blob/4db363a03c182349f8491f46ced258d84723b11f/core/tauri/README.md?plain=1#L3 (and in other packages there) |
tbh I don't think any of the reasons listed really matter, at least in the short term, so imo we should focus on getting the docs running first and add this improvement to the Todo list for later :) |
Yeah, we probably gonna need to fix those as well.
I agree, I am not saying it is a blocker, just something to think about for the future. |
Updates the banners on the readme's to absolute paths so that downstream docs CI has nice banners