Skip to content

Commit

Permalink
fix(docs): a bit more context on adding defillama protocol urls (#2986)
Browse files Browse the repository at this point in the history
  • Loading branch information
ccerv1 authored Feb 6, 2025
1 parent c18a955 commit ca1d55b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
2 changes: 1 addition & 1 deletion apps/docs/docs/projects/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Make sure to use the latest version of the oss-directory schema. You can see the

The schema currently contains the following fields:

- `version`: The latest version of the OSS Directory schema. This is a required field. To find the latest version, open any project YAML file and get the version from the top of the file. As of writing (2024-10-15), the latest version is Version 7.
- `version`: The latest version of the OSS Directory schema. This is a required field. To find the latest version, open any project YAML file and get the version from the top of the file. As of writing (2025-02-06), the latest version is Version 7.
- `name`: The unique identifier for the project. See [Give Your Project a Unique `name` Slug](#give-your-project-a-unique-name-slug) for more information. This is a required field and must match the name of the YAML project file.
- `display_name`: The display name of the project. This is a required field and must also be globally unique.
- `description`: A brief description of the project.
Expand Down
5 changes: 5 additions & 0 deletions apps/docs/docs/projects/update-artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ Version 7 of the oss-directory schema currently supports the following artifact
The simplest way to add all contracts and factories associated with your project is to just include the deployer address in the project file with the `deployer` tag. We will then automatically index all contracts and factories that originate from the deployer address. If the deployer is on multiple EVM networks, you can use the `any_evm` network label instead of listing each network individually.
:::

## DefiLlama

- `defillama`: A list of DefiLlama protocol URLs, eg. `https://defillama.com/protocol/my-protocol-v1`.

## Open Collective

- `open_collective`: An Open Collective URL, eg. `https://opencollective.com/my-project`.
Expand All @@ -57,3 +61,4 @@ We recommend the following examples of project files to help you get started:
- [pandas](/~https://github.com/opensource-observer/oss-directory/blob/main/data/projects/p/pandas.yaml)
- [safe-global](/~https://github.com/opensource-observer/oss-directory/blob/main/data/projects/s/safe-global.yaml)
- [uniswap](/~https://github.com/opensource-observer/oss-directory/blob/main/data/projects/u/uniswap.yaml)
- [wormhole](/~https://github.com/opensource-observer/oss-directory/blob/main/data/projects/w/wormhole.yaml)

0 comments on commit ca1d55b

Please sign in to comment.