Skip to content

Commit

Permalink
docs: merge Wallet API part in discover section [LIVE-11987] (#360)
Browse files Browse the repository at this point in the history
  • Loading branch information
Justkant authored May 27, 2024
1 parent d15c65d commit 1b843da
Show file tree
Hide file tree
Showing 96 changed files with 10 additions and 25 deletions.
9 changes: 2 additions & 7 deletions .github/workflows/sync_doc_devportal.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ on:
branches:
- main
paths:
- "apps/docs/pages/APIs/wallet-api/*"
- "apps/docs/pages/docs/discover/*"

jobs:
Expand All @@ -26,12 +25,10 @@ jobs:
DEVELOPER_PORTAL_CI_TOKEN: ${{ secrets.DEVELOPER_PORTAL_CI }}
SOURCE_REPO_NAME: "wallet-api"
SOURCE_REPO: "github.com/LedgerHQ/wallet-api"
SOURCE_FILE_PATH_1: "apps/docs/pages/APIs/wallet-api"
SOURCE_FILE_PATH_2: "apps/docs/pages/docs/discover"
SOURCE_FILE_PATH_1: "apps/docs/pages/docs/discover"
TARGET_REPO_NAME: "developer-portal"
TARGET_REPO: "github.com/LedgerHQ/developer-portal"
TARGET_FILE_PATH_1: "pages/APIs/wallet-api"
TARGET_FILE_PATH_2: "pages/docs/discover"
TARGET_FILE_PATH_1: "pages/docs/discover"
TARGET_BRANCH: "main"
TARGET_PR_API_URL: "https://api.github.com/repos/LedgerHQ/developer-portal/pulls"
PR_TITLE: "Merging documentation from wallet-api"
Expand All @@ -48,11 +45,9 @@ jobs:
# Replace files
cp -rT ../${SOURCE_REPO_NAME}/${SOURCE_FILE_PATH_1} ${TARGET_FILE_PATH_1}
cp -rT ../${SOURCE_REPO_NAME}/${SOURCE_FILE_PATH_2} ${TARGET_FILE_PATH_2}
# Push changes
git add ${TARGET_FILE_PATH_1}
git add ${TARGET_FILE_PATH_2}
git commit -m "${PR_COMMIT_MESSAGE}" || echo "No changes to commit"
git push origin ${PR_BRANCH_NAME}
Expand Down
3 changes: 0 additions & 3 deletions apps/docs/pages/APIs/_meta.json

This file was deleted.

4 changes: 0 additions & 4 deletions apps/docs/pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,5 @@
"docs": {
"title": "Documentation",
"type": "page"
},
"APIs": {
"title": "APIs",
"type": "page"
}
}
15 changes: 6 additions & 9 deletions apps/docs/pages/docs/discover/guidelines.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Live Apps submission guidelines
description: All Live Apps need to go through a validation process by our Live App Review Team.
---

import { Callout } from 'nextra/components'
import { Callout } from "nextra/components";

# Live Apps submission guidelines

Expand All @@ -14,16 +14,16 @@ All Live Apps need to go through a validation process by our Live App Review Tea
- Review the guidelines below
- Get in touch with us on the [Ledger Discord server](https://developers.ledger.com/discord/) to discuss your project.
- If there is need to share data with us, read this [doc](https://docs.google.com/document/d/1pD2iht4nAphDDEMikwJjD2OG8x4cc9BcUJ1QeMDE94Y/edit?usp=sharing)
- If you want your App to be showcased, contact [email protected]
- If you want your App to be showcased, contact [email protected]

<Callout type="warning" emoji="⚠️">
We reserve the right to perform KYB (including regulatory compliance review) and may reject your submission based on such KYB.
We reserve the right to perform KYB (including regulatory compliance review)
and may reject your submission based on such KYB.
</Callout>


## Guidelines

To avoid slowing down the review process or get a rejection, follow the steps below. While this list is not a substitute for the guidelines and does not guarantee approval, ensuring that you can check off every item is a good first step.
To avoid slowing down the review process or get a rejection, follow the steps below. While this list is not a substitute for the guidelines and does not guarantee approval, ensuring that you can check off every item is a good first step.

Make sure that:

Expand All @@ -32,7 +32,7 @@ Make sure that:
- Clear Signing on hardware
- Analytics so we can monitor product performance
- In case of DApps on EVM chains, you have created a Dune Dashboard to monitor the performance of your DApp when used in Ledger Live, as it is a requirement to be listed in the search bar
- The app leverages the [Wallet API](/APIs/wallet-api/introduction)
- The app leverages the [Wallet API](./wallet-api/introduction)
- All the app information and metadata is complete and accurate
- You test your app for crashes and bugs
- The app forbids logging through other wallets
Expand All @@ -42,6 +42,3 @@ Make sure that:
## Maintenance

Please note that if, in the future, your Live App is no longer working as intended or active support is no longer provided, it will be removed from the search bar and the Discover sections.



4 changes: 2 additions & 2 deletions apps/docs/pages/docs/discover/wallet-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ title: How to add a DApp with the Wallet API?
To integrate a DApp with the Wallet API, you need to:

- Read the [submission guidelines](./guidelines)
- Use the [Wallet API](../../APIs/wallet-api/introduction)
- Write a manifest as explained in the [Wallet API documentation](../../APIs/wallet-api/appendix/manifest)
- Use the [Wallet API](./wallet-api/introduction)
- Write a manifest as explained in the [Wallet API documentation](./wallet-api/appendix/manifest)
File renamed without changes.

0 comments on commit 1b843da

Please sign in to comment.