Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@okineadev
Copy link
Contributor

chore: move readme to packages/toon/README.md and symlink in the project root

@okineadev okineadev force-pushed the do-not-copy-readme branch 2 times, most recently from 6fb9eb4 to db2a263 Compare November 25, 2025 13:28
@okineadev
Copy link
Contributor Author

Please wait

@okineadev okineadev marked this pull request as ready for review November 26, 2025 07:09
@okineadev
Copy link
Contributor Author

Ready for review!

@johannschopplich
Copy link
Collaborator

LGTM! Thanks.

@johannschopplich johannschopplich merged commit 56ece18 into toon-format:main Nov 26, 2025
1 check passed
@johannschopplich
Copy link
Collaborator

@okineadev I had to revert the change, since GitHub was not able to render the intro image (even with the patb ../../.github/og.png):

Bildschirmfoto 2025-11-26 um 08 23 29

I think it's not worth persuing further, I think our time is better off at other parts of the repo. :)

@okineadev
Copy link
Contributor Author

@okineadev I had to revert the change, since GitHub was not able to render the intro image (even with the patb ../../.github/og.png):

Bildschirmfoto 2025-11-26 um 08 23 29 I think it's not worth persuing further, I think our time is better off at other parts of the repo. :)

Now I see

This seems to be because GitHub treats all paths in README.md (which symlinked to packages/toon/README.md) relative to the project root and not packages/toon.

The problem is that I don't know how the NPM page will treat it..

Like if you published what I just did, would the NPM page treat these paths relative to the project root or relative to that folder?

I think the same as GitHub - relatively to the root of the GitHub project.


Well, it needs a little more pre-testing.

@okineadev
Copy link
Contributor Author

I have thoroughly tested this and can confirm that we should use paths relative to the project root and not relative to packages/toon (as was the case in this PR)

Here is the confirmation:

I created a test npm package and also its repository to demonstrate that both GitHub and NPM paths will work relative to the root of the GitHub project:

https://npmjs.com/package/npm-package-test-222
https://github.com/okineadev/npm-package-test

image

So this confirms that we should actually use paths relative to the project root and everything will work perfectly on both GitHub and NPM.


Could we give it only one try?

@johannschopplich
Copy link
Collaborator

Allright, let's give it another try!

You have to create a new PR tho.

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