website/fix: extending configuration files urls #844
Conversation
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/formium/tsdx/qkooh8qci |
agilgur5
changed the title
|
|
||
| ## ESLint | ||
|
|
||
| You can add your own `.eslintrc.js` to the root of your project and TSDX will **deep merge** it with [its own ESLint config](./src/createEslintConfig.ts). | ||
| You can add your own `.eslintrc.js` to the root of your project and TSDX will **deep merge** it with [its own ESLint config](../../src/createEslintConfig.ts). |
There was a problem hiding this comment.
This doesn't actually solve the problem, as you can see in the preview website.
These are relative URLs from the README, and they work from the README, but these files are not (and should not be) hosted on the website, so a relative URL to code will never work here
|
They weren't moved, rather Jared mostly copy+pasted the README into the website, which creates several inconsistencies that are not clear how they should be handled (e.g. README has been updated, website has not, no comparison section, no contributors section, relative links don't work, some new paragraphs were added exclusively to the website...). It did not go through code review and was pushed directly to master, otherwise I would've pointed out these issues.... 😕 I'm going to assign this to @jaredpalmer to get his response as no maintenance plan was provided for the website (I'm the only active maintainer...) and all the inconsistencies create problems that confuse users like you and even me. But per my comment, this code won't work in any case, so it does not resolve the inconsistency. |
|
I think we can solve this problem on the website by linking directly to the files on GitHub (e.g., |
|
@kyarik you can, but that means they're not 1-to-1 anymore and can't be copy+pasted without modifications. Duplicate but slightly different content is bound to get out-of-sync and already is in fact (violates DRY too) |
|
@agilgur5 I see your point, but we can solve this issue by having absolute URLs in the README as well... |
|
@kyarik they're not equivalent. Absolute URLs point to a specific commit-ish whereas relative URLs point to their own branch/fork/etc's code and changing the branch name or fork name has no impact on them |
|
This is now blocked by a resolution for #848 |
agilgur5
added
progress: blocked
solution: invalid
agilgur5
changed the title
agilgur5
changed the title
agilgur5
added
the
scope: docs
|
Superseded by #923 which uses absolute links for now. |
The links to the example configuration files seem to have moved and were not working on the main website.