third-party-mirrors/EDDN
1
0
Fork 0
mirror of https://github.com/EDCD/EDDN.git synced 2025-04-22 19:40:30 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs/Developers: Use relative schemas/ link & tweak horizons/odyssey flags reference

Browse Source
This commit is contained in:
Athanasius 2022-01-30 13:07:38 +00:00
parent ead10a2c1e
commit 10c43e5304
No known key found for this signature in database
GPG Key ID: AE3E527847057C7D
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/Developers.md
View File

@ -218,9 +218,9 @@ For example, a shipyard message, version 2, might look like:
### Contents of `message`
Every message MUST comply with the Schema its `$schemaRef` value cites. Each
Schema file should have a matching `<schema>-README.md` file in the project
root `schemas/` directory. Always consult this so that you're aware of any
Schema-specific requirements.
Schema file should have a matching `<schema>-README.md` file in the
[project root schemas/ directory](../schemas/)
. Always consult this so that you're aware of any Schema-specific requirements.
The Schema file, `<schema>-v<version>.json`, is considered the authority on
the format of messages for that Schema. If anything in the accompanying
@ -261,9 +261,10 @@ So, be sure you're checking the live versions and not, e.g. those in the
3. At least one other key/value pair representing the data. In general there
will be much more than this. Consult the
[Schemas and their documentation](./).
4. Include
[horizons and odyssey flags](#horizons-and-odyssey-flags) where the
Schema requires them.
Please consult the advice pertaining to
[horizons and odyssey flags](#horizons-and-odyssey-flags) and include them
whenever possible.
2. Because the first versions of some Schemas were defined when only the CAPI
data was available, before Journal files existed, many of the key names chosen