Skip to content

Commit 83d04c2

Browse files
committed
Update references to sample extension
1 parent 7fab2ab commit 83d04c2

File tree

4 files changed

+8
-5
lines changed

4 files changed

+8
-5
lines changed

src/content/docs/dev/publishing.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,16 @@ moonlight CI builds the `develop` branch automatically. This section is for publ
4747
- In [the sample extension](https://github.com/moonlight-mod/sample-extension), update the types package: `pnpm update @moonlight-mod/types`
4848
- Remember to `git pull` and `pnpm i` beforehand so you are up to date.
4949
- Commit and push to the sample extension.
50+
- Update [create-extension](https://github.com/moonlight-mod/create-extension) following [these instructions](#publishing-other-libraries).
5051

51-
## Publishing LunAST/moonmap/mappings
52+
## Publishing other libraries
53+
54+
(e.g. moonmap, LunAST, mappings, create-extension)
5255

5356
- Update package.json with a new version.
5457
- Commit and push to `main`.
5558
- Create a tag with the version, **starting with the character `v`**: `git tag vX.Y.Z`
5659
- Same reasoning as [above](#publishing-moonlight).
5760
- Push the tag: `git push --tags`
5861
- Wait for the package to be uploaded to npm.
59-
- Use [the update helper script](/dev/helper-scripts) to update the dependencies in moonlight.
62+
- Use [the update helper script](/dev/helper-scripts) to update the dependencies in moonlight if needed.

src/content/docs/ext-dev/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Getting started
3-
description: Information on getting started with the sample extension
3+
description: Information on getting started with moonlight extension development
44
sidebar:
55
order: 1
66
---

src/content/docs/ext-dev/official-repository.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Then, create a pull request to [the official repository][extensions], adding a m
2626
}
2727
```
2828

29-
`repository` must be a valid HTTPS Git URL. `commit` must be a valid commit in that repository. `scripts` is an array of pnpm scripts to build your project - for repositories using the sample extension, this will be `build` and `repo`. `artifact` is the location of the output file - for repositories using the sample extension, this will be `repo/<extension id>.asar`.
29+
`repository` must be a valid HTTPS Git URL. `commit` must be a valid commit in that repository. `scripts` is an array of pnpm scripts to build your project - for repositories using the official build script, this will be `build` and `repo`. `artifact` is the location of the output file - for repositories using the sample extension, this will be `repo/<extension id>.asar`.
3030

3131
## Adoption rules
3232

src/content/docs/ext-dev/pitfalls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Note that esbuild will merge string concatenation, so you must be creative!
3535

3636
## Using JSX
3737

38-
[JSX](https://react.dev/learn/writing-markup-with-jsx) (and its TypeScript version, TSX) is an extension of JavaScript that allows you to write HTML-like syntax in your code. The default configuration of the sample extension is to convert the JSX to `React.createElement` calls:
38+
[JSX](https://react.dev/learn/writing-markup-with-jsx) (and its TypeScript version, TSX) is an extension of JavaScript that allows you to write HTML-like syntax in your code. The default configuration of the build script is to convert the JSX to `React.createElement` calls:
3939

4040
```tsx
4141
const myElement = <span>Hi!</span>;

0 commit comments

Comments
 (0)