docs(readme): add new docs link #2010
Merged
Conversation
This file contains 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
Fix the status badges and include a link to the documentation page that is now generated
|
|
This creates a `CITATION.cff` file. The information is taken from arXiv's bibtex for the whitepaper:
```bibtex
@inproceedings{Feist_2019, doi = {10.1109/wetseb.2019.00008}, url = {https://doi.org/10.1109%2Fwetseb.2019.00008}, year = 2019, month = {may}, publisher = {{IEEE} }, author = {Josselin Feist and Gustavo Grieco and Alex Groce}, title = {Slither: A Static Analysis Framework for Smart Contracts}, booktitle = {2019 {IEEE}/{ACM} 2nd International Workshop on Emerging Trends in Software Engineering for Blockchain ({WETSEB})} }
```
Citation example in the GitHub UI
|
elopez
reviewed
Jun 29, 2023
CITATION.cff
Outdated
| - given-names: Gustavo | ||
| family-names: Grieco | ||
| - given-names: Alex | ||
| family-names: Grace |
There was a problem hiding this comment.
Suggested change
| family-names: Grace | |
| family-names: Groce |
fixed slack badge added wiki badge updated pypi badge
corrected spelling mistakes took abstract from paper and added it into the description note: AGPL-3.0-only is lower case as the citation.cff validator said so. [I used this https://citation-file-format.github.io/cff-initializer-javascript/#/finish](https://citation-file-format.github.io/cff-initializer-javascript/#/finish)
|
Not sure what the subheading under the slack badge should say, just left a generic statement there. Also I just joined, had to make sure the invite works :) |
|
Thanks @sambacha! |
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.
Fix the status badges and include a link to the documentation page that is now generated
Edit:
Additional changes include a direct link to the wiki
updated slack badge to join
more information in the citation.cff file
slight style changes regarding the markup of the header