Skip to content

Commit

Permalink
Merge branch 'cardano-foundation:staging' into staging
Browse files Browse the repository at this point in the history
  • Loading branch information
RayTracedObserver authored Aug 18, 2024
2 parents a2785bf + 00e0589 commit 5e435f9
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 16 deletions.
23 changes: 12 additions & 11 deletions docs/tutorial/add-company.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,23 @@ Thank you for considering adding your company, association or collaboration to [

## Requirements

Before making a pull request, please make sure that you fulfil all these requirements.
Before making a pull request, please make sure that you fulfill all these requirements.

### Requirements of your company, association or collaboration
- You can only add a registered company or association, but not a product, service or tool. These can be added to the [Cardano Showcase](https://developers.cardano.org/showcase). By "collaboration" we mean open source collaborations such as the **Koios Team** or the **Guild Operators**. They do not necessarily have to be registered but need to fullfil all other requirements.
- That your company has a product, service or tool that is listed on either [Cardano Showcase](https://developers.cardano.org/showcase) or [Builder Tools](https://developers.cardano.org/tools).
- Your product, service or tools needs to work today on Cardano mainnet, no coming soon, no preview, no promises, no token sales.
- You can only add a registered company, an association, or a collaboration. By "collaboration" we mean open source collaborations such as the **Koios Team** or the **Guild Operators**.
- You cannot add a product, service or tool. These can be added to the [Cardano Showcase](https://developers.cardano.org/showcase).
- Ensure that your company/association/collaboration has a product, service or tool that is listed on either [Cardano Showcase](https://developers.cardano.org/showcase) or [Builder Tools](https://developers.cardano.org/tools).
- Your product, service, or tool needs to work today on Cardano mainnet, no coming soon, no preview, no promises, no token sales.

### Website Requirement
- Link to the company website and not to the product website. Examples: don't link to **Flint Wallet** but to **dcSpark**. Don't link to **CardanoScan** but to **Strica**.
- Your company website has to have a stable domain name. (a random Netlify/Vercel domain is not allowed, no URL shortener, no app store links, or similar)
- Link to the company/association/collaboration website and not to the product website. Examples: don't link to **Flint Wallet** but to **dcSpark**. Don't link to **CardanoScan** but to **Strica**.
- Your company/association/collaboration website has to have a stable domain name. (a random Netlify/Vercel domain is not allowed, no URL shortener, no app store links, or similar)
- Don't link to token pages. Example: don't link to **World Mobile Token** but to **World Mobile**.
- If you have registered your product as a company or you have the same website for both, please link to a team or about Us page. Examples: entries of **DripDropz** and **jpg.store**.
- If you have registered your product as a company/association/collaboration or you have the same website for both, please link to a team or about Us page. Examples: entries of **DripDropz** and **jpg.store**.

### Logo Requirements
- Have your company, association or collaboration logo as SVG (Scalable Vector Graphics) file. In order to maintain a certain quality standard, no jpg, png or other formats are accepted.
- You need one that looks good on white background and one that looks good an dark background. (Light mode / dark mode)
- Have your company/association/collaboration logo as SVG (Scalable Vector Graphics) file. In order to maintain a certain quality standard, no jpg, png or other formats are accepted.
- You need one that looks good on white background and one that looks good a dark background. (Light mode / dark mode)
- Avoid a transparent border around the logo otherwise it will be displayed too small.
- If you specify a size in the SVG file, do not go below 600x600.

Expand All @@ -36,10 +37,10 @@ Before making a pull request, please make sure that you fulfil all these require

To create a pull request that adds your company named `Amazing Company`:

- Fullfil all the above requirements.
- Fulfill all the above requirements.
- Copy your two logos (light and dark mode) to the folder `static/img/logos`. Name them `amazingcompany.svg` and `amazingcompany-dark.svg`.
- Make changes to the JSON file as shown below.
- The field `showCompanyName` can set to true if your company logo does not include the company name already. The name of the company is then displayed under the logo. Example: TxPipe and DripDropz. The company name
- The field `showCompanyName` can be set to true if your company logo does not already include the company name. The name of the company is then displayed under the logo. Example: TxPipe and DripDropz.
- The field `knownFor` must be set to at least one product/service or tool that is listed on either [Cardano Showcase](https://developers.cardano.org/showcase) or [Builder Tools](https://developers.cardano.org/tools).

```jsx title="src/data/logosCompanies.json"
Expand Down
1 change: 0 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ const config = {
showReadingTime: false,
routeBasePath: 'news',
blogSidebarCount: 17,
onUntruncatedBlogPosts: 'ignore',
editUrl: `${vars.repository}/edit/${vars.branch}`,
},
theme: {
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "^3.4.0",
"@docusaurus/preset-classic": "^3.4.0",
"@docusaurus/core": "^3.5.2",
"@docusaurus/preset-classic": "^3.5.2",
"@emotion/react": "^11.11.3",
"@emotion/styled": "^11.11.0",
"@mdx-js/react": "^3.0.0",
Expand All @@ -30,8 +30,8 @@
"react-tabs": "^6.0.2"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.4.0",
"@docusaurus/types": "^3.2.0"
"@docusaurus/module-type-aliases": "^3.5.2",
"@docusaurus/types": "^3.5.2"
},
"browserslist": {
"production": [
Expand Down

0 comments on commit 5e435f9

Please sign in to comment.