Better test descriptions #144
Merged
Conversation
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
nrichers
added
DO NOT MERGE
cachafla
approved these changes
Nov 2, 2023
There was a problem hiding this comment.
Looks great 👍
I left a related comment here: validmind/validmind-library#282 (comment)
Let's go with this v1 and we can improve upon the format and metadata of the tests later.
nrichers
added
documentation
|
Pull requests must include a description in the release notes section. |
2 similar comments
|
Pull requests must include a description in the release notes section. |
|
Pull requests must include a description in the release notes section. |
|
Updated the Makefile to make the test descriptions part of the source we fetch from the developer-framework repo and added a release notes description with a link. Also switched to a tabbed view after chatting with Andres some more.
|
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Internal Notes for Reviewers
This PR embeds the files from @cachafla's validmind/validmind-library#282 in a new landing page. It's basically the
tests/folder copied over intosite/and then the files get embedded a couple of times:_quarto.ymlguide/test-descriptions.qmdNo Makefile updates, yet, as this is just a demo.
Note we have the option to expand the left sidebar but, if you do, it makes for a loooong list of tests. Just using the landing page with the tests collapsed to the level shown in the next section might be preferrable. We can also specify how many tests are shown for each section. (The tool I used for the screenshot doesn't quite show the sidebar accurately, FYI.)
Output
External Release Notes
We added better descriptions for the tests that are available in the ValidMind Developer Framework along with a new landing page where you can browse through all of the tests. Our docs site search now also indexes these descriptions, making them easier to find. Try it ...