Merged
Conversation
hstrowd
approved these changes
Feb 14, 2025
Collaborator
hstrowd
left a comment
There was a problem hiding this comment.
Looks great. All comments are non-blocking. Thanks so much for putting this together. 💪
DLavin23
reviewed
Feb 14, 2025
Contributor
DLavin23
left a comment
There was a problem hiding this comment.
Left some small typo and phrasing related comments, but otherwise, this looks awesome. Great work!
| <link rel="stylesheet" href="{{ '/tailwind.build.css' | relative_url }}"> | ||
| </head> | ||
| <body> | ||
| <header class="sticky top-0 z-50 flex items-center justify-between px-3 py-2 border-b shadow-lg bg-white/90 backdrop-blur-sm border-slate-400/40"> |
Contributor
There was a problem hiding this comment.
In general, do we care about viewing these docs on a mobile device? I noticed we at least hide the nav, but don't make it viewable on smaller screens.
readme/interface/validate.md
Outdated
|
|
||
| When you run `bin/featuremap validate`, the following files will automatically be generated: | ||
| * `.feature_map/assignments.yml`: Captures a mapping of files within a repository to their corresponding feature and a mapping of features to their corresponding files. | ||
| * `.feature_map/metrics.yml`: Captures a set of metrics rolled up at the feature level (i.e. computed over all files assigned to the feature). |
Contributor
There was a problem hiding this comment.
Depending on which gets merged first, we mighit need to add the additional-metrics.yml file from #57
| - Generated by [`bin/featuremap test_coverage`]({{ '/interface/test-coverage' | relative_url }}) | ||
| - Stores per-Feature aggregated test coverage data from codecov | ||
| - Optional | ||
| - `.feature_map/test-pyramid.yml` |
Contributor
There was a problem hiding this comment.
Similar comment, once #57 gets merged, I think we'll want this to reference the .feature_map/additional-metrics.yml
Co-authored-by: Harrison Strowd <harrison@haresoft.dev>
Co-authored-by: Harrison Strowd <harrison@haresoft.dev>
Co-authored-by: Harrison Strowd <harrison@haresoft.dev>
Co-authored-by: Harrison Strowd <harrison@haresoft.dev>
Co-authored-by: Harrison Strowd <harrison@haresoft.dev>
Co-authored-by: Harrison Strowd <harrison@haresoft.dev>
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
3 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.
Adds a github pages documentation site, available at: https://beyond-finance.github.io/feature_map/. Note: that URL represents the current site built from this branch, so you can check it out as part of review. It also updates the project's README to remove items that are now documented as part of the readme site.
This also adds bin scripts to run the doc site, and the readme site, locally. Finally, it sets the readme site as the website for this repository in github:
