Skip to content

Commit c318085

Browse files
committed
chore: cleaned up docs and moved rust documentation to docs rs
1 parent d38a404 commit c318085

File tree

7 files changed

+43
-146
lines changed

7 files changed

+43
-146
lines changed

astro.config.ts

Lines changed: 4 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -48,50 +48,17 @@ export default defineConfig({
4848
link: "/infomation/intro/",
4949
},
5050
{
51-
label: "Documentation",
51+
label: "JS Documentation",
5252
items: [
5353
{
5454
label: "Installation",
55-
link: "/guides/install/",
56-
},
57-
{
58-
label: "OAuth",
59-
link: "/guides/oauth/",
60-
badge: {
61-
text: "Recomended!",
62-
variant: "success",
63-
},
64-
},
65-
{
66-
label: "DeviceCode",
67-
link: "/guides/device_code/",
68-
badge: {
69-
text: "Secure!",
70-
variant: "note",
71-
},
72-
},
73-
{
74-
label: "Launching",
75-
link: "/guides/launching",
76-
badge: {
77-
text: "Experimental",
78-
variant: "caution",
79-
},
55+
link: "/js/install/",
8056
},
8157
],
8258
},
8359
{
84-
label: "Resources",
85-
items: [
86-
{
87-
label: "Docs.rs",
88-
link: "https://docs.rs/minecraft-essentials/",
89-
},
90-
{
91-
label: "Crates.io",
92-
link: "https://crates.io/minecraft-essentials/",
93-
},
94-
],
60+
label: "Rust Documentation",
61+
link: "https://docs.rs/minecraft-essentials/",
9562
},
9663
{
9764
label: "Minecraft Clients",
Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,33 @@
11
---
2-
import Tabs from './Tabs.astro';
3-
import { TabItem } from '@astrojs/starlight/components';
2+
import Tabs from "./Tabs.astro";
3+
import { TabItem } from "@astrojs/starlight/components";
4+
5+
interface Props {
6+
js?: boolean;
7+
}
8+
const { js } = Astro.props;
49
---
510

611
<Tabs group="package-managers">
7-
<TabItem label="Cargo">
8-
<slot name="cargo" />
9-
</TabItem>
10-
<TabItem label="Bun">
11-
<slot name="bun" />
12-
</TabItem>
13-
<TabItem label="Yarn">
14-
<slot name="yarn" />
15-
</TabItem>
16-
<TabItem label="pnpm">
17-
<slot name="pnpm" />
18-
</TabItem>
19-
<TabItem label="npm">
20-
<slot name="npm" />
21-
</TabItem>
22-
</Tabs>
12+
{
13+
js && (
14+
<>
15+
<TabItem label="Deno">
16+
<slot name="deno" />
17+
</TabItem>
18+
<TabItem label="Bun">
19+
<slot name="bun" />
20+
</TabItem>
21+
<TabItem label="Yarn">
22+
<slot name="yarn" />
23+
</TabItem>
24+
<TabItem label="pnpm">
25+
<slot name="pnpm" />
26+
</TabItem>
27+
<TabItem label="npm">
28+
<slot name="npm" />
29+
</TabItem>
30+
</>
31+
)
32+
}
33+
</Tabs>

src/content/docs/guides/device_code.mdx

Lines changed: 0 additions & 19 deletions
This file was deleted.

src/content/docs/guides/launching.mdx

Lines changed: 0 additions & 14 deletions
This file was deleted.

src/content/docs/guides/oauth.mdx

Lines changed: 0 additions & 51 deletions
This file was deleted.

src/content/docs/infomation/intro.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,9 @@ You can find updates on GitHub at our [Roadmap](https://github.com/orgs/minecraf
3131
## Roadmap
3232

3333

34-
Our roadmap is easily avavlible on [GitHub](https://github.com/orgs/minecraft-essentials/projects/1)
34+
Our roadmap is easily avavlible on [GitHub](https://github.com/orgs/minecraft-essentials/projects/1)
35+
36+
37+
38+
# Rust Documentation
39+
If your looking for the rust documentation you can find it [here](https://docs.rs/minecraft-essentials/)

src/content/docs/guides/install.mdx renamed to src/content/docs/js/install.mdx

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,11 @@ description: How to install the package
77
import PackageManagerTabs from "@src/components/docs/PackageMangerTabs.astro";
88

99
:::caution
10-
**This is subjected to CHANGE at any time as this is Experimental**
10+
**Work In Progress**
1111
:::
1212

1313

14-
15-
## Installing Via Your NPM Package Manager
16-
14+
## Installation
1715

1816
<PackageManagerTabs>
1917
<Fragment slot="npm">
@@ -36,9 +34,9 @@ import PackageManagerTabs from "@src/components/docs/PackageMangerTabs.astro";
3634
bun add minecraft-essentials
3735
```
3836
</Fragment>
39-
<Fragment slot="cargo">
37+
<Fragment slot="deno">
4038
```shell
41-
cargo add minecraft-essentials
39+
deno install npm:minecraft-essentials
4240
```
4341
</Fragment>
4442
</PackageManagerTabs>

0 commit comments

Comments
 (0)