Skip to content

Commit 9acf14a

Browse files
CrauzerCrauzer
committed
feat: enhance documentation structure and content for League of Legends meta wiki
1 parent 114219f commit 9acf14a

File tree

6 files changed

+177
-34
lines changed

6 files changed

+177
-34
lines changed

‎site/astro.config.mjs‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,21 @@ export default defineConfig({
1414
customCss: [
1515
"./src/styles/custom.css",
1616
],
17+
editLink: {
18+
// Enable "Edit this page" linking to GitHub for PRs
19+
baseUrl: 'https://github.com/LeagueToolkit/lol-meta-wiki/edit/main/site/src/content',
20+
},
1721
social: [
1822
{
1923
icon: "github",
2024
label: "GitHub",
21-
href: "https://github.com/withastro/starlight",
25+
href: "https://github.com/LeagueToolkit/lol-meta-wiki",
2226
},
2327
],
2428
sidebar: [
2529
{
2630
label: "Guides",
27-
items: [
28-
// Each item here is one entry in the navigation menu.
29-
{ label: "Example Guide", slug: "guides/example" },
30-
],
31+
autogenerate: { directory: "guides" },
3132
},
3233
{
3334
label: "Reference",

‎site/src/assets/logo.svg‎

Lines changed: 33 additions & 0 deletions
Loading

‎site/src/content/docs/classes/index.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Classes
3+
description: Browse League of Legends meta (.bin) classes with inheritance and properties.
4+
---
5+
6+
Use the sidebar to navigate classes. Each class page includes inheritance details and property documentation.
7+
8+
## Tips
9+
10+
- Use site search to find a class by name.
11+
- Click "Add documentation" on a class page to contribute via GitHub PR.
12+
13+

‎site/src/content/docs/guides/index.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Guides
3+
description: Community-written guides for working with LoL meta data and tools.
4+
---
5+
6+
Welcome to the Guides section. Here you'll find practical, community-written walkthroughs and tips.
7+
8+
## Start here
9+
10+
- [Writing Guides](/guides/writing-guides/)
11+
- [Example Guide](/guides/example/)
12+
13+
New guides will appear here automatically after they are merged.
14+
15+

‎site/src/content/docs/guides/writing-guides.mdx‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: Writing Guides
3+
description: How to create and submit a guide to the LoL Meta Wiki.
4+
---
5+
6+
Welcome! This page explains how to write a guide and submit it as a GitHub pull request.
7+
8+
## Before you start
9+
10+
- Guides live in `site/src/content/docs/guides/`.
11+
- Write guides in Markdown or MDX (`.md` or `.mdx`).
12+
- Include frontmatter at the top with `title` and `description`.
13+
14+
### Quick template
15+
16+
```md
17+
---
18+
title: Your Guide Title
19+
description: One-line summary of what readers will learn.
20+
---
21+
22+
## Introduction
23+
24+
Explain the context and the goal.
25+
26+
## Steps
27+
28+
1. Step one...
29+
2. Step two...
30+
31+
## Examples
32+
33+
Show a minimal, working example.
34+
35+
## Further reading
36+
37+
Link to related classes, reference pages, or external resources.
38+
```
39+
40+
## Submit via GitHub UI (no local setup)
41+
42+
1. Open the guides folder on GitHub: [`site/src/content/docs/guides`](https://github.com/LeagueToolkit/lol-meta-wiki/tree/main/site/src/content/docs/guides)
43+
2. Click “Add file” → “Create new file”.
44+
3. Name it like `my-guide-name.md`.
45+
4. Paste the template above and write your content.
46+
5. Commit changes and open a Pull Request.
47+
48+
Once merged, your guide will automatically appear under the **Guides** section in the sidebar.
49+
50+
## Submit locally (for larger edits)
51+
52+
```bash
53+
git clone https://github.com/LeagueToolkit/lol-meta-wiki.git
54+
cd lol-meta-wiki
55+
pnpm install
56+
57+
# Create your guide
58+
$EDITOR site/src/content/docs/guides/my-guide-name.md
59+
60+
# Preview the site
61+
pnpm generate-db
62+
pnpm dev
63+
```
64+
65+
Open a PR when you're ready. The site is built with Astro + Starlight and will show an “Edit this page” link on docs pages for quick fixes.
66+
67+
## Style tips
68+
69+
- Prefer short sections and concrete examples.
70+
- Link to classes (under `/classes/`) and reference pages when relevant.
71+
- Keep titles descriptive and use the `description` to set expectations.
72+

‎site/src/content/docs/index.mdx‎

Lines changed: 38 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,49 @@
11
---
2-
title: Welcome to Starlight
3-
description: Get started building your docs site with Starlight.
4-
template: splash # Remove or comment out this line to display the site sidebar on this page.
2+
title: LoL Meta Wiki
3+
description: Explore League of Legends meta classes, read community guides, and contribute your knowledge.
4+
template: splash
55
hero:
6-
tagline: Congrats on setting up a new Starlight project!
6+
tagline: Community-driven documentation for League of Legends meta (.bin) classes.
77
image:
8-
file: ../../assets/houston.webp
8+
file: ../../assets/logo.svg
9+
alt: LoL Meta Wiki logo
910
actions:
10-
- text: Example Guide
11-
link: /guides/example/
12-
icon: right-arrow
13-
- text: Read the Starlight docs
14-
link: https://starlight.astro.build
15-
icon: external
11+
- text: Browse Classes
12+
link: /classes/
13+
- text: Read Guides
14+
link: /guides/
15+
- text: How to Contribute
16+
link: /guides/writing-guides/
1617
variant: minimal
1718
---
1819

19-
import { Card, CardGrid } from '@astrojs/starlight/components';
20+
import { Card, CardGrid } from "@astrojs/starlight/components";
2021

21-
## Next steps
22+
## What you can do here
2223

2324
<CardGrid stagger>
24-
<Card title="Update content" icon="pencil">
25-
Edit `src/content/docs/index.mdx` to see this page change.
26-
</Card>
27-
<Card title="Change page layout" icon="document">
28-
Delete `template: splash` in `src/content/docs/index.mdx` to display a
29-
sidebar on this page.
30-
</Card>
31-
<Card title="Add new content" icon="add-document">
32-
Add Markdown or MDX files to `src/content/docs` to create new pages.
33-
</Card>
34-
<Card title="Configure your site" icon="setting">
35-
Edit your `sidebar` and other config in `astro.config.mjs`.
36-
</Card>
37-
<Card title="Read the docs" icon="open-book">
38-
Learn more in [the Starlight Docs](https://starlight.astro.build/).
39-
</Card>
25+
<Card title="Understand meta classes" icon="layers">
26+
Dive into thousands of meta classes with inheritance graphs and property
27+
details.
28+
</Card>
29+
<Card title="Learn from guides" icon="open-book">
30+
Read practical, community-written guides about working with game data and
31+
tools.
32+
</Card>
33+
<Card title="Contribute knowledge" icon="pencil">
34+
Improve class/property docs or write a new guide — all changes happen via
35+
GitHub PRs.
36+
</Card>
4037
</CardGrid>
38+
39+
## How to contribute
40+
41+
- Update class/property docs: Use the "Add documentation" buttons on class pages.
42+
- Write a guide: Follow the steps in [Writing Guides](/guides/writing-guides/).
43+
- Fix mistakes: Click "Edit this page" on any doc to open a PR.
44+
45+
## Quick links
46+
47+
- Guides: [/guides/](/guides/)
48+
- Classes: [/classes/](/classes/)
49+
- Reference: [/reference/](/reference/)

0 commit comments

Comments
 (0)