Skip to content

Commit 68efbd6

Browse files
committed
Fix article references in docs
1 parent d1f736a commit 68efbd6

File tree

7 files changed

+15
-15
lines changed

7 files changed

+15
-15
lines changed

ChartTools/Docs/articles/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Read and write operations in ChartTools feature customizable behavior for how they handle various error cases. These behaviors can be defines throguh the use of configuration objects.
44

5-
The following snippet uses a [ChartReadingConfiguration](~/api/ChartTools.IO.Chart.Configuration.ChartReadingConfiguration.yml) to only include the first of duplicate [track objects](~/api/ChartTools.ITrackObject):
5+
The following snippet uses a [ChartReadingConfiguration](~/api/ChartTools.IO.Chart.Configuration.ChartReadingConfiguration.yml) to only include the first of duplicate [track objects](~/api/ChartTools.ITrackObject.yml):
66

77
```csharp
88
using ChartTools.IO.Chart.Configuration;

ChartTools/Docs/articles/dynamic-syntax.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The dynamic syntax uses three enums to get instruments:
2121
Drums do not an enum for their chord types as they are the only instrument using their respective chords.
2222

2323
## Generic vs. non-generic
24-
When an instrument is obtained dynamically using the [InstrumentIdentity](~/api/ChartTools.InstrumentIdentity.yml) enum, the returned object is of type [Instrument](~/api/ChartTools.Instrument.yml). When a track is obtained from a non-generic instrument, either dynamically or explicitly through a property, the track will be of type [Track](~/api/ChartTools.Trac.yml). This concept extends to chords and notes.
24+
When an instrument is obtained dynamically using the [InstrumentIdentity](~/api/ChartTools.InstrumentIdentity.yml) enum, the returned object is of type [Instrument](~/api/ChartTools.Instrument.yml). When a track is obtained from a non-generic instrument, either dynamically or explicitly through a property, the track will be of type [Track](~/api/ChartTools.Track.yml). This concept extends to chords and notes.
2525

2626
When working with a non-generic track, the following rules apply:
2727
- Chords cannot be added or removed. The position of existing chords can be modified.

ChartTools/Docs/articles/getting-started.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Getting Started
1+
# Getting Started
22
This document will go over the basics of parsing and saving a chart using ChartTools.
33

44
## Installation
@@ -20,7 +20,7 @@ Every component of a chart is stored in an instance of the [Song](~/api/ChartToo
2020
Song song = Song.FromFile(path);
2121
```
2222

23-
A configuration object may also be used to customize the error handling behavior. [Learn more about configuring IO operations](~/articles/configuration.yml).
23+
A configuration object may also be used to customize the error handling behavior. [Learn more about configuring IO operations](~/articles/configuration.md).
2424

2525
```csharp
2626
Song song = Song.FromFile(path, new ReadingConfiguration());
@@ -43,7 +43,7 @@ A song contains four main components:
4343

4444
- [Metadata](~/api/ChartTools.Metadata.yml) - Miscellaneous info about the song, such as title, album, charter etc.
4545
- [Sync track](~/api/ChartTools.SyncTrack.yml) - Markers that define time signature and tempo
46-
- [Global events](~/articles/events.md.yml) - Events not tied to an instrument or track
46+
- [Global events](~/articles/events.md) - Events not tied to an instrument or track
4747
- [Instruments](~/api/ChartTools.InstrumentSet.yml) - Instruments, tracks and notes
4848
- [Vocals](~/api/ChartTools.Lyrics.Vocals.yml) - Vocals notes paired with lyric text
4949

@@ -85,15 +85,15 @@ An instrument is a collection of tracks, each representing a difficulty level. C
8585
- Guitar Hero Live bass
8686

8787
> [!NOTE]
88-
> ChartTools also supports vocals, but does not consider them as an instrument. [Learn more about vocals](~/articles/vocals.yml).
88+
> ChartTools also supports vocals, but does not consider them as an instrument. [Learn more about vocals](~/articles/vocals.md).
8989
9090
A track can be retrieved from a song as such:
9191

9292
```csharp
9393
Track<StandardChord> track = song.Instruments.StandardLeadGuitar.Expert;
9494
```
9595

96-
Notice the use of [StandardChord](~/api/ChartTools.StandardChord.yml) as a generic type. Instruments are divided into four categories based on the type of chords they use. These categories are:
96+
Notice the use of [StandardChord](~/api/ChartTools.StandardChord) as a generic type. Instruments are divided into four categories based on the type of chords they use. These categories are:
9797

9898
- Standard - Five colored notes
9999
- Drums - Five colored notes with support for double kick and cymbal flags
@@ -103,12 +103,12 @@ A track is composed of three components:
103103

104104
- Chords - Defined by the generic type
105105
- Special phrases - Primarily used for star power
106-
- [Local events](events.md)
106+
- [Local events](~/articles/events.md)
107107

108-
Instruments can also be obtained dynamically from a song, regardless of the type. [Learn more about the dynamic syntax](dynamic-syntax.md).
108+
Instruments can also be obtained dynamically from a song, regardless of the type. [Learn more about the dynamic syntax](~/articles/dynamic-syntax.md).
109109

110110
### Chords and Notes
111-
A chord is a set of notes played at the same time. For readability, most chords and notes have specific classes for each instrument type, deriving from [Chord<TNote, TLane, TModifiers>](~/api/ChartTools.Chord-3.yml) and [LaneNode\<TLane\>](~/api/ChartTools.LaneNote-1.yml).
111+
A chord is a set of notes played at the same time. For readability, most chords and notes have specific classes for each instrument type, deriving from [Chord<TNote, TLane, TModifiers>](~/api/ChartTools.Chord-3) and [LaneNode\<TLane\>](~/api/ChartTools.LaneNote-1).
112112

113113
The following snippet adds an orange note to every chord on a track:
114114

@@ -122,7 +122,7 @@ foreach (StandardChord chord in song.Instruments.StandardLeadGuitar.Expert)
122122
```
123123

124124
## Tools
125-
As the name suggests, *ChartTools* also provides various tools to help fix and optimize songs. [Learn more](~/articles/tools).
125+
As the name suggests, *ChartTools* also provides various tools to help fix and optimize songs. [Learn more](~/articles/tools.md).
126126

127127
## Writing files
128128
Finally, changes can be saved to a file, with the format determined by the file extension.

ChartTools/Docs/articles/improving-performance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
This guide will cover alternate techniques that will improve performance when using ChartTools.
33

44
## Configuration
5-
By default, IO operations make multiple integrity checks to resolve errors. These checks can be configured or skipped by using a [Readingconfiguration](~/api/ChartTools.IO.Configuration.ReadingConfiguration.yml) or [WritingConfiguration](~/api/ChartTools.IO.Configuration.WritingConfiguration.yml) object. [Learn more about configuring IO operations](~/articles/configuration.yml).
5+
By default, IO operations make multiple integrity checks to resolve errors. These checks can be configured or skipped by using a [Readingconfiguration](~/api/ChartTools.IO.Configuration.ReadingConfiguration.yml) or [WritingConfiguration](~/api/ChartTools.IO.Configuration.WritingConfiguration.yml) object. [Learn more about configuring IO operations](~/articles/configuration.md).
66

77
The following example reads a song while bypassing checks for duplicate track objects:
88

ChartTools/Docs/articles/lyrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ VocalsPitchValue value = pitch;
4242
> ```
4343
4444
## Lyrics in chart files
45-
As the `.chart` format does not formaly support playable vocals, lyrics are represented trough [global events](~/articles/events.yml) rather than notes. When reading from a `.chart` file, lyric data will only be read if either the [GlobalEvents](~/api/ChartTools.IO.Components.ComponentList#ChartTools_IO_Components_ComponentList_GlobalEvents.yml) or [Vocals](~/api/ChartTools.IO.Components.ComponentList#ChartTools_IO_Components_ComponentList_Vocals.yml) component is enabled, after which the data will be stored in the corresponding location(s) in the song object. If accessed through vocals, notes will have the special pitch value of [None](~/api/ChartTools.Lyrics.VocalsPitchValue.yml#ChartTools_Lyrics_VocalsPitchValue_None.yml), as global events do not define pitch.
45+
As the `.chart` format does not formaly support playable vocals, lyrics are represented trough [global events](~/articles/events.md) rather than notes. When reading from a `.chart` file, lyric data will only be read if either the [GlobalEvents](~/api/ChartTools.IO.Components.ComponentList#ChartTools_IO_Components_ComponentList_GlobalEvents.yml) or [Vocals](~/api/ChartTools.IO.Components.ComponentList#ChartTools_IO_Components_ComponentList_Vocals.yml) component is enabled, after which the data will be stored in the corresponding location(s) in the song object. If accessed through vocals, notes will have the special pitch value of [None](~/api/ChartTools.Lyrics.VocalsPitchValue.yml#ChartTools_Lyrics_VocalsPitchValue_None.yml), as global events do not define pitch.
4646
4747
Lyrics can also be converted to and from global events.
4848

ChartTools/Docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ If you find any bugs, you can report them in the [Issues section](https://github
66
As this project is in development, it should only be used with charts with a backup available. **I am not responsible for damages to charts!**
77

88
## Getting Started
9-
For an overview on installation and taking your first steps with ChartTools, see [Articles](~/articles/getting-started). A GitHub Pages website is available with detailed articles and API documentation.
9+
For an overview on installation and taking your first steps with ChartTools, see [Articles](~/articles/getting-started.md). A GitHub Pages website is available with detailed articles and API documentation.
1010

1111
## Contributing
1212
If you like to contribute to the development of ChartTools, feel free to comment on an issue, submit a pull request or submit your own issues.

ChartTools/Docs/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
- name: Articles
22
href: articles/
33
- name: Api Documentation
4-
href: api/ChartTools
4+
href: api/
55
- name: Repository
66
href: https://github.com/theboxybear/charttools

0 commit comments

Comments
 (0)