Skip to content

Commit 186e818

Browse files
committed
revise: adds some SEO attributes, updates links to GitHub
1 parent 5f8ca8b commit 186e818

File tree

4 files changed

+25
-15
lines changed

4 files changed

+25
-15
lines changed

app.vue

+11
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,17 @@
66
</div>
77
</template>
88

9+
<script setup lang="ts">
10+
useSeoMeta({
11+
title: "rust-seq",
12+
ogTitle: "Documentation",
13+
description:
14+
"rust-seq: a project that endeavours to rebuild the omics ecosystem using Rust",
15+
ogDescription:
16+
"A project that endeavours to rebuild the omics ecosystem using Rust",
17+
});
18+
</script>
19+
920
<style lang="postcss">
1021
* {
1122
@apply text-slate-900;

components/ContextMenu.vue

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
<div class="links">
2121
<ColorMode />
22-
<a href="https://github.com/rust-seq/docs">
22+
<a href="https://github.com/rust-seq/rust-seq.github.io">
2323
<Icon class="mx-auto w-6 h-6" name="mdi:github"></Icon>
2424
</a>
2525
</div>

content/docs/get-started/2.values.md

+12-13
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ when failures occur. Eliminating these modes of failure in omics development and
1212
analyses is one of the primary reasons the project was created.
1313

1414
To that end, correctness should be considered the highest priority of crates in the
15-
`rust-seq` stack—**even at the cost of performance**.
15+
`rust-seq` stack—**even at the cost of performance**.
1616

17-
In situations where performance is critical, developers should provide both a _safe_
18-
and _unsafe_ interface, clearly documenting the pre-requisites for the _unsafe_ interface
19-
at the API level. Likewise, any `unsafe` code should be explicity documented (in the code)
20-
with a comment beginning with the token `SAFETY:`, that explicitly describes why the code
17+
In situations where performance is critical, developers should provide both a _safe_
18+
and _unsafe_ interface, clearly documenting the pre-requisites for the _unsafe_ interface
19+
at the API level. Likewise, any `unsafe` code should be explicity documented (in the code)
20+
with a comment beginning with the token `SAFETY:`, that explicitly describes why the code
2121
in the unsafe block is expected to operate correctly and not invoke undefined behavior.
2222

2323
## Performant
@@ -103,7 +103,7 @@ recommend you dual license the crate to be used under the [MIT
103103
License](https://opensource.org/license/MIT) or the [Apache-2.0
104104
License](https://opensource.org/license/apache-2-0) at the user's discretion.
105105

106-
Notably, library crates (i.e. crates that are expected to become dependencies of other
106+
Notably, library crates (i.e. crates that are expected to become dependencies of other
107107
crates) _must_ be made accessible under any number of the following licenses (in
108108
alphabetical order):
109109

@@ -116,22 +116,21 @@ alphabetical order):
116116
- or any public domain license (e.g.,
117117
[Unlicense](https://opensource.org/license/unlicense)).
118118

119-
While _all_ crates are strongly encouraged to adopt a license from the above
120-
set, binary crates (i.e. command line applications that are not expected to be a
121-
dependency of other crates or tools) _may_ adopt a stronger copyleft license
119+
While _all_ crates are strongly encouraged to adopt a license from the above
120+
set, binary crates (i.e. command line applications that are not expected to be a
121+
dependency of other crates or tools) _may_ adopt a stronger copyleft license
122122
from the list below:
123123

124-
125124
- [Affero](https://www.gnu.org/licenses/agpl-3.0.en.html),
126125
- [CDDL](https://opensource.org/license/cddl-1-0),
127126
- [GPL](https://www.gnu.org/licenses/gpl-3.0.en.html),
128127
- [LGPL](https://www.gnu.org/licenses/lgpl-3.0.en.html),
129128
- [Mozilla Public License 2.0](https://www.mozilla.org/en-US/MPL/2.0/).
130129

131-
Finally, crates (regardless of type) are explicitly _disallowed_ from using any
132-
non-permissive or non-copyleft proprietary license (e.g. any license that stipulates
130+
Finally, crates (regardless of type) are explicitly _disallowed_ from using any
131+
non-permissive or non-copyleft proprietary license (e.g. any license that stipulates
133132
the crate is "free for non-commercial use" or other such conditions or restrictions).
134133

135134
If any question is not sufficiently covered by the above license reviews, please [file
136135
an
137-
issue](https://github.com/rust-seq/docs/issues/new?labels=license&title=license:%20evaluation%20of%20LICENSE).
136+
issue](https://github.com/rust-seq/rust-seq.github.io/issues/new?labels=license&title=license:%20evaluation%20of%20LICENSE).

pages/docs/[...slug].vue

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,4 +83,4 @@ breadcrumbs.push({
8383
</aside>
8484
</div>
8585
</div>
86-
</template>
86+
</template>

0 commit comments

Comments
 (0)