Skip to content

Commit

Permalink
revise: adds some SEO attributes, updates links to GitHub
Browse files Browse the repository at this point in the history
  • Loading branch information
claymcleod committed Oct 12, 2024
1 parent 5f8ca8b commit 186e818
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 15 deletions.
11 changes: 11 additions & 0 deletions app.vue
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@
</div>
</template>

<script setup lang="ts">
useSeoMeta({
title: "rust-seq",
ogTitle: "Documentation",
description:
"rust-seq: a project that endeavours to rebuild the omics ecosystem using Rust",
ogDescription:
"A project that endeavours to rebuild the omics ecosystem using Rust",
});
</script>

<style lang="postcss">
* {
@apply text-slate-900;
Expand Down
2 changes: 1 addition & 1 deletion components/ContextMenu.vue
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

<div class="links">
<ColorMode />
<a href="https://github.com/rust-seq/docs">
<a href="https://github.com/rust-seq/rust-seq.github.io">
<Icon class="mx-auto w-6 h-6" name="mdi:github"></Icon>
</a>
</div>
Expand Down
25 changes: 12 additions & 13 deletions content/docs/get-started/2.values.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ when failures occur. Eliminating these modes of failure in omics development and
analyses is one of the primary reasons the project was created.

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

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

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

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

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

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


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

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

If any question is not sufficiently covered by the above license reviews, please [file
an
issue](https://github.com/rust-seq/docs/issues/new?labels=license&title=license:%20evaluation%20of%20LICENSE).
issue](https://github.com/rust-seq/rust-seq.github.io/issues/new?labels=license&title=license:%20evaluation%20of%20LICENSE).
2 changes: 1 addition & 1 deletion pages/docs/[...slug].vue
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,4 @@ breadcrumbs.push({
</aside>
</div>
</div>
</template>
</template>

0 comments on commit 186e818

Please sign in to comment.