Relativize doc links, to fix links in docs site (#7964)

This commit is contained in:
Raymond Dodge 2025-10-18 04:56:40 -04:00 committed by GitHub
parent 721f385e1d
commit eeceff27e7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 19 additions and 20 deletions

View File

@ -36,7 +36,6 @@ def proc_items(items):
s = s.replace('](README.md)', '](./)')
s = s.replace('](/INSTALL.md', '](INSTALL.md')
s = s.replace('](docs/', '](')
s = s.replace('](/docs/', '](/')
s = URL_RE.sub(handle_url, s)
item['Chapter']['content'] = ANCHOR_RE.sub(handle_anchor, s)
proc_items(item['Chapter']['sub_items'])

View File

@ -1,2 +1,2 @@
## Running documentation website locally
- [Ubuntu WSL1/WSL2](/docs/local_mdbook/ubuntu_WSL.md)
- [Ubuntu WSL1/WSL2](ubuntu_WSL.md)

View File

@ -7,7 +7,7 @@ This document is a guide for maintainers to account for all the reccomended step
# Checklist
## Is the branch's theoretical functionality in scope?
If you're not sure if a branch's functionality is [in scope](docs/team_procedures/scope.md), start a conversation on Discord to resolve.
If you're not sure if a branch's functionality is [in scope](scope.md), start a conversation on Discord to resolve.
## Does the branch successfully compile?
From `make clean`, the branch should locally compile.
@ -37,18 +37,18 @@ If you're not sure if something CAN be tested, start a discussion. Some contribu
If any new tests are `KNOWN_FAILING`, issues should be opened describing each of the `KNOWN_FAILING` tests and our understanding of why they fail.
## Does the branch meet our [config philosophy](/docs/STYLEGUIDE.md#config-philosophy)?
## Does the branch meet our [config philosophy](../STYLEGUIDE.md#config-philosophy)?
## Does the branch meet our [saves philosophy](/docs/STYLEGUIDE.md#saves-philosophy)?
## Does the branch meet our [saves philosophy](../STYLEGUIDE.md#saves-philosophy)?
## Does the submitted code follow the [styleguide](/docs/STYLEGUIDE.md)?
## Does the submitted code follow the [styleguide](../STYLEGUIDE.md)?
This applies to code that comes from other branches or games.
## Is the pull request appropriately labeled?
Without labels, the CHANGELOG will not be properly formatted. For specifically the `bugfix` label, an additional label, detailing what area the bug exists in is required.
## Is `pokeemerald-expansion` free from a merge freeze?
Our [release schedule](/docs/team_procedures/schedule.md) prevents us from merging Big Features and non-bugfixes within certain dates close to a release. Please use `/release` in the RHH Discord to clarify when these are occuring.
Our [release schedule](schedule.md) prevents us from merging Big Features and non-bugfixes within certain dates close to a release. Please use `/release` in the RHH Discord to clarify when these are occuring.
# Merging

View File

@ -53,4 +53,4 @@ This designation should be reserved for instances where an existing feature on `
Blocking issues or PRs can be deferred to future releases but should be discussed with the Maintainers that assigned the designation in the first place.
If a version's milestone does not have any issues or PRs assigned to it, that version should be [released](https://github.com/rh-hideout/pokeemerald-expansion/blob/master/docs/team_procedures/expansion_versions.md) as close to the goal date as possible.
If a version's milestone does not have any issues or PRs assigned to it, that version should be [released](expansion_versions.md) as close to the goal date as possible.

View File

@ -23,8 +23,8 @@ When writing map scripts, `fadescreenswapbuffers` should be preferred over `fade
### Q: How do I make lightbulbs glow?
![Rustboro before adding lamp object events](/docs/tutorials/img/dns/without_lamp.png)
![Rustboro after adding lamp object events](/docs/tutorials/img/dns/with_lamp.png)
![Rustboro before adding lamp object events](img/dns/without_lamp.png)
![Rustboro after adding lamp object events](img/dns/with_lamp.png)
A: Making lamps glow is not part of the tileset itself. Instead, place certain object events on top of where you desire a glowing effect.
@ -48,7 +48,7 @@ on separate lines to mark those colors as being light-blended, i.e:
During the day time, these color indices appear as normal, but will be blended with either yellow or the 0 index at night. These indices should only be used for things you expect to light up. If you are using [porytiles](https://github.com/grunt-lucas/porytiles/wiki), palette overrides and using slight alterations to a color will aid you in avoiding color conflicts where the wrong index is assigned.
![Rustboro gym after light-blending the windows](/docs/tutorials/img/dns/window_lights.png)
![Rustboro gym after light-blending the windows](img/dns/window_lights.png)
The windows appear as normal during the day time (blue) and light up in the night. These use the default color.

View File

@ -2,7 +2,7 @@
*Written by Bivurnum*
*gif by ghoulslash*
![follower-npc](/docs/tutorials/img/follower_npc/follower-npc.gif)
![follower-npc](img/follower_npc/follower-npc.gif)
## Configs
The configs for follower NPCs can be found in [include/config/follower_npc.h](https://github.com/rh-hideout/pokeemerald-expansion/blob/upcoming/include/config/follower_npc.h).

View File

@ -42,7 +42,7 @@ The main things that the Expansion changes are listed here.
# Useful resources
You can open a sprite debug menu by pressing `Select` in a Pokémon's summary screen outside of battle.
![visualizer1](/docs/tutorials/img/add_pokemon/visualizer1.gif)
![visualizer1](img/add_pokemon/visualizer1.gif)
# The Data - Part 1
@ -73,7 +73,7 @@ We add this at the end so that no existing species change Id and so that we don'
Now, let's see how it looks in-game!
![visualizer2](/docs/tutorials/img/add_pokemon/visualizer2.png)
![visualizer2](img/add_pokemon/visualizer2.png)
Hmmm, something's not right...
@ -446,7 +446,7 @@ Now we can add the number and entry to our Mewthree:
},
};
```
![image](/docs/tutorials/img/add_pokemon/dex1.png)
![image](img/add_pokemon/dex1.png)
The values `pokemonScale`, `pokemonOffset`, `trainerScale` and `trainerOffset` are used for the height comparison figure in the Pokédex.
@ -497,7 +497,7 @@ Edit [src/data/pokemon/pokedex_orders.h](https://github.com/rh-hideout/pokeemera
...
};
```
![mGBA_lUBfmFEKUx](/docs/tutorials/img/add_pokemon/dex2.gif)
![mGBA_lUBfmFEKUx](img/add_pokemon/dex2.gif)
# The Graphics
@ -1058,7 +1058,7 @@ What this allows us to do is to be able to get all forms of a Pokémon in our co
For example, in the HGSS dex, it lets us browse between the entries of every form available.:
![hgssdex1](/docs/tutorials/img/add_pokemon/hgssdex1.png) ![image](/docs/tutorials/img/add_pokemon/hgssdex2.png)
![hgssdex1](img/add_pokemon/hgssdex1.png) ![image](img/add_pokemon/hgssdex2.png)
In addition, we have the `GET_BASE_SPECIES_ID` macro, which returns the first entry of the table (or return the species itself if it doesn't have a table registered). With this, you can check if a Pokémon is any form of a species. For example, making it so that the Light Ball affects all Pikachu forms:
```c
@ -1089,7 +1089,7 @@ The second value is the target form, to which the Pokémon will change into.
Values after that are referred as arguments, and needs to be put there depends on the type of form change, detailed in `include/constants/form_change_types.h`.
## 3. Gender differences
![gender_diffs](/docs/tutorials/img/add_pokemon/gender_diffs.gif)
![gender_diffs](img/add_pokemon/gender_diffs.gif)
You may have seen that there's a couple of duplicate fields with a "Female" suffix.
```diff
@ -1262,8 +1262,8 @@ Either way, you may also create custom animation tables and use them here approp
### How to add the Pokémon Object Events to map
In Porymap, select the object you want to set the sprite to. Then, change the field "Sprite" to use `OBJ_EVENT_GFX_SPECIES(SPECIES)`, replacing SPECIES with the name of the species you want to use. If you get a compiler error, it's because it used the species define as part of the macro, so it needs to match how you defined it all the way back in [Declare a species constant](#1-Declare-a-species-constant).
![charizard](/docs/tutorials/img/add_pokemon/charizard.png)
![overworld_data](/docs/tutorials/img/add_pokemon/overworld_data.gif)
![charizard](img/add_pokemon/charizard.png)
![overworld_data](img/add_pokemon/overworld_data.gif)
If you want to use their shiny and/or female versions, use one of the following macros:
- `OBJ_EVENT_GFX_SPECIES_SHINY(name)`