feat: refine docs of testing library#141
Merged
Huxpro merged 9 commits intolynx-family:mainfrom May 8, 2025
Merged
Conversation
upupming
force-pushed
the
feat/refine-testing-library
branch
6 times, most recently
from
37bb26f to
6c34ac2
Compare
Collaborator
|
Why is there no preview on this...? |
✅ Deploy Preview for lynx-doc ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
2 tasks
Huxpro
requested changes
May 7, 2025
Collaborator
Huxpro
left a comment
Huxpro
left a comment
There was a problem hiding this comment.
The TypeDoc part looks really promising. Consider taking advantage of that by referencing concepts and APIs to the API references whenever you code in your guide writing.
Also consider referencing to external materials whenever you could.
github-merge-queue bot
pushed a commit
to lynx-family/lynx-stack
that referenced
this pull request
May 7, 2025
<!-- Thank you for submitting a pull request! We appreciate the time and effort you have invested in making these changes. Please ensure that you provide enough information to allow others to review your pull request. Upon submission, your pull request will be automatically assigned with reviewers. If you want to learn more about contributing to this project, please visit: https://github.com/lynx-family/lynx-stack/blob/main/CONTRIBUTING.md. --> ## Summary <!-- Can you explain the reasoning behind implementing this change? What problem or issue does this pull request resolve? --> <!-- It would be helpful if you could provide any relevant context, such as GitHub issues or related discussions. --> In this PR, we refine our documentation of testing library. - rename `@lynx-js/test-environment` to `@lynx-js/testing-environment` - rename `LynxEnv` to `LynxTestingEnv` - rename `react-lynx-testing-library` to `reactlynx-testing-library` See also: lynx-family/lynx-website#141 ## Checklist <!--- Check and mark with an "x" --> - [ ] Tests updated (or **not required**). - [x] Documentation updated (or not required).
Huxpro
approved these changes
May 8, 2025
Collaborator
Huxpro
left a comment
Huxpro
left a comment
There was a problem hiding this comment.
It's almost perfect! After fixing the final pieces we'd love to have this merged
upupming
force-pushed
the
feat/refine-testing-library
branch
from
b09eeff to
474521f
Compare
Change-Id: I903bdad09ec0693905315a2dcbebc86f953b6c1c
Change-Id: Ic97bd9459f0194373ed343d1ab7f6f6113de5922
Change-Id: I0ea5c90e1c956e740e8872fe4a9ec9cdaafc1e5d
Change-Id: I3201de9a6b951332ab84dcdf5f0a70b579ba6791
Change-Id: I5021c7685cdd04495bd528a89da117beab2346de
Change-Id: I1d804b13976defed2ebb611809c071a1d9d1db78
Change-Id: I12a8ac1dad4d2892d7840d15c62cbf4665d97288
Change-Id: If328c6b6c6ffe86ea24b84d12b56be0be183d81f
Change-Id: Ife130ee7905be0e6c861bc392a8fe5af59496864
upupming
force-pushed
the
feat/refine-testing-library
branch
from
10f4202 to
baa1dc6
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In this PR, we refine our documentation of testing library.
typedoctool for generating docs from type decl@lynx-js/test-environmentto@lynx-js/testing-environmentreact-lynx-testing-librarytoreactlynx-testing-library