From e8dc4943b014551154e24962edcd3977bd8ef147 Mon Sep 17 00:00:00 2001
From: Omar Tawfik <15987992+OmarTawfik@users.noreply.github.com>
Date: Sun, 11 Aug 2024 17:05:23 -0700
Subject: [PATCH] update README links (#1069)
---
README.md | 16 +++++++++-------
crates/metaslang/bindings/README.md | 7 ++++---
crates/metaslang/cst/README.md | 7 ++++---
crates/metaslang/cst/src/query/parser.rs | 4 ++--
crates/metaslang/graph_builder/README.md | 7 ++++---
.../outputs/cargo/slang_solidity/README.md | 10 ++++++----
crates/solidity/outputs/npm/package/README.md | 10 ++++++----
.../cargo/tests/src/query/parser_tests.rs | 4 ++--
8 files changed, 37 insertions(+), 28 deletions(-)
diff --git a/README.md b/README.md
index bdb6cab5a..02becfa07 100644
--- a/README.md
+++ b/README.md
@@ -13,15 +13,17 @@ A modular set of compiler APIs empowering the next generation of Solidity code a
Written in Rust and distributed in multiple languages.
- [Announcement Post](https://medium.com/nomic-foundation-blog/slang-rethnet-2ad465fd7880)
-- [Slang Internals](https://nomicfoundation.github.io/slang/internals/)
+- [How to write your own Solidity linter using Slang, in 25 lines of code!](https://blog.nomic.foundation/how-to-write-your-own-solidity-linter-using-slang-356e7565ad1b/)
+- [Slang Internals](https://nomicfoundation.github.io/slang/latest/internals/)
This repository maintains the source code and release process for these projects:
-- [Slang Rust Crate + CLI](https://nomicfoundation.github.io/slang/user-guide/rust-crate/)
-- [Slang TypeScript Package](https://nomicfoundation.github.io/slang/user-guide/npm-package/)
-- [Solidity Language Specification](https://nomicfoundation.github.io/slang/solidity-specification/)
-
-
+- [Slang Rust Crate + CLI](https://nomicfoundation.github.io/slang/latest/user-guide/rust-crate/)
+- [Slang TypeScript Package](https://nomicfoundation.github.io/slang/latest/user-guide/npm-package/)
+- [Solidity Language Specification](https://nomicfoundation.github.io/slang/latest/solidity-specification/)
> ❗ This project is still in alpha, and is under active development.
-> If you are planning on using it, please reach out to us on [Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
+> If you are planning on using it, please [reach out to us on Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
+
+- [Slang Telegram Group](https://t.me/+pxApdT-Ssn5hMTFh)
+- [We are hiring!](https://nomic.foundation/jobs)
diff --git a/crates/metaslang/bindings/README.md b/crates/metaslang/bindings/README.md
index 30cf663c4..c1fabdc3e 100644
--- a/crates/metaslang/bindings/README.md
+++ b/crates/metaslang/bindings/README.md
@@ -16,7 +16,8 @@ generated by `metaslang`.
## Solidity compiler tooling by [@NomicFoundation](https://github.com/NomicFoundation)
-
-
> ❗ This project is still in alpha, and is under active development.
-> If you are planning on using it, please reach out to us on [Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
+> If you are planning on using it, please [reach out to us on Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
+
+- [Slang Telegram Group](https://t.me/+pxApdT-Ssn5hMTFh)
+- [We are hiring!](https://nomic.foundation/jobs)
diff --git a/crates/metaslang/cst/README.md b/crates/metaslang/cst/README.md
index fc08b57da..d14f40e72 100644
--- a/crates/metaslang/cst/README.md
+++ b/crates/metaslang/cst/README.md
@@ -9,7 +9,8 @@
This crate provides support for parse trees used in the Solidity compiler tooling.
-
-
> ❗ This project is still in alpha, and is under active development.
-> If you are planning on using it, please reach out to us on [Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
+> If you are planning on using it, please [reach out to us on Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
+
+- [Slang Telegram Group](https://t.me/+pxApdT-Ssn5hMTFh)
+- [We are hiring!](https://nomic.foundation/jobs)
diff --git a/crates/metaslang/cst/src/query/parser.rs b/crates/metaslang/cst/src/query/parser.rs
index 6f490ac9a..733973205 100644
--- a/crates/metaslang/cst/src/query/parser.rs
+++ b/crates/metaslang/cst/src/query/parser.rs
@@ -98,10 +98,10 @@ impl fmt::Display for QuerySyntaxError {
write!(f, "Invalid escaped Unicode character")
}
QuerySyntaxError::DeprecatedEllipsis => {
- write!(f, "The ellipsis `...` operator is deprecated, and replaced with a new adjacency `.` operator. For more information, check the Tree Query Language guide: https://nomicfoundation.github.io/slang/user-guide/tree-query-language/")
+ write!(f, "The ellipsis `...` operator is deprecated, and replaced with a new adjacency `.` operator. For more information, check the Tree Query Language guide: https://nomicfoundation.github.io/slang/latest/user-guide/tree-query-language/")
}
QuerySyntaxError::ForbiddenTriviaKind => {
- write!(f, "Matching trivia nodes directly is forbidden. For more information, check the Tree Query Language guide: https://nomicfoundation.github.io/slang/user-guide/tree-query-language/")
+ write!(f, "Matching trivia nodes directly is forbidden. For more information, check the Tree Query Language guide: https://nomicfoundation.github.io/slang/latest/user-guide/tree-query-language/")
}
}
}
diff --git a/crates/metaslang/graph_builder/README.md b/crates/metaslang/graph_builder/README.md
index 87473c288..c2de9cba6 100644
--- a/crates/metaslang/graph_builder/README.md
+++ b/crates/metaslang/graph_builder/README.md
@@ -21,7 +21,8 @@ This library is currently not intended to be
This crate defines a DSL for constructing arbitrary graph
structures from source code that has been parsed using parsers generated using `metaslang`.
-
-
> ❗ This project is still in alpha, and is under active development.
-> If you are planning on using it, please reach out to us on [Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
+> If you are planning on using it, please [reach out to us on Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
+
+- [Slang Telegram Group](https://t.me/+pxApdT-Ssn5hMTFh)
+- [We are hiring!](https://nomic.foundation/jobs)
diff --git a/crates/solidity/outputs/cargo/slang_solidity/README.md b/crates/solidity/outputs/cargo/slang_solidity/README.md
index ea8b2f3d8..4f133f53d 100644
--- a/crates/solidity/outputs/cargo/slang_solidity/README.md
+++ b/crates/solidity/outputs/cargo/slang_solidity/README.md
@@ -13,9 +13,11 @@ A modular set of compiler APIs empowering the next generation of Solidity code a
Written in Rust and distributed in multiple languages.
- [Announcement Post](https://medium.com/nomic-foundation-blog/slang-rethnet-2ad465fd7880)
-- [User Guide](https://nomicfoundation.github.io/slang/user-guide/rust-crate/)
-
-
+- [How to write your own Solidity linter using Slang, in 25 lines of code!](https://blog.nomic.foundation/how-to-write-your-own-solidity-linter-using-slang-356e7565ad1b/)
+- [User Guide](https://nomicfoundation.github.io/slang/latest/user-guide/rust-crate/)
> ❗ This project is still in alpha, and is under active development.
-> If you are planning on using it, please reach out to us on [Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
+> If you are planning on using it, please [reach out to us on Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
+
+- [Slang Telegram Group](https://t.me/+pxApdT-Ssn5hMTFh)
+- [We are hiring!](https://nomic.foundation/jobs)
diff --git a/crates/solidity/outputs/npm/package/README.md b/crates/solidity/outputs/npm/package/README.md
index b505d4842..bf40d9068 100644
--- a/crates/solidity/outputs/npm/package/README.md
+++ b/crates/solidity/outputs/npm/package/README.md
@@ -13,9 +13,11 @@ A modular set of compiler APIs empowering the next generation of Solidity code a
Written in Rust and distributed in multiple languages.
- [Announcement Post](https://medium.com/nomic-foundation-blog/slang-rethnet-2ad465fd7880)
-- [User Guide](https://nomicfoundation.github.io/slang/user-guide/npm-package/)
-
-
+- [How to write your own Solidity linter using Slang, in 25 lines of code!](https://blog.nomic.foundation/how-to-write-your-own-solidity-linter-using-slang-356e7565ad1b/)
+- [User Guide](https://nomicfoundation.github.io/slang/latest/user-guide/npm-package/)
> ❗ This project is still in alpha, and is under active development.
-> If you are planning on using it, please reach out to us on [Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
+> If you are planning on using it, please [reach out to us on Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
+
+- [Slang Telegram Group](https://t.me/+pxApdT-Ssn5hMTFh)
+- [We are hiring!](https://nomic.foundation/jobs)
diff --git a/crates/testlang/outputs/cargo/tests/src/query/parser_tests.rs b/crates/testlang/outputs/cargo/tests/src/query/parser_tests.rs
index 3ed6dc0cc..78686dd32 100644
--- a/crates/testlang/outputs/cargo/tests/src/query/parser_tests.rs
+++ b/crates/testlang/outputs/cargo/tests/src/query/parser_tests.rs
@@ -115,7 +115,7 @@ fn test_fails_parsing_ellipsis() {
Ok(_) => panic!("Expected parse failure"),
Err(e) => assert_eq!(
e.message,
- "Parse error:\nThe ellipsis `...` operator is deprecated, and replaced with a new adjacency `.` operator. For more information, check the Tree Query Language guide: https://nomicfoundation.github.io/slang/user-guide/tree-query-language/ at: ...]\n",
+ "Parse error:\nThe ellipsis `...` operator is deprecated, and replaced with a new adjacency `.` operator. For more information, check the Tree Query Language guide: https://nomicfoundation.github.io/slang/latest/user-guide/tree-query-language/ at: ...]\n",
),
}
}
@@ -154,7 +154,7 @@ fn test_fails_parsing_trivia_node_selector() {
Ok(_) => panic!("Expected parse failure"),
Err(e) => assert_eq!(
e.message,
- "Parse error:\nMatching trivia nodes directly is forbidden. For more information, check the Tree Query Language guide: https://nomicfoundation.github.io/slang/user-guide/tree-query-language/ at: EndOfLine]\n"
+ "Parse error:\nMatching trivia nodes directly is forbidden. For more information, check the Tree Query Language guide: https://nomicfoundation.github.io/slang/latest/user-guide/tree-query-language/ at: EndOfLine]\n"
),
}
}