Skip to content

DEVDOCS-6277 - update content for new dev portal #915

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

bc-terra
Copy link
Contributor

@bc-terra bc-terra commented Apr 21, 2025

Dev Portal 2.0 updates

  • developer-portal.mdx
  • publishing.mdx
  • guide.mdx
  • glossary.mdx
  • nextjs-quick-start.mdx
  • nextjs-connect.mdx

DEVDOCS-6277

What changed?

  • The Developer Portal experience is updated! Some big call-outs include
    • A fresh new design to match the new control panel experience.
    • New navigation experience to streamline the app creation process.
    • A new publication workflow for getting apps into the marketplace seamlessly

Release notes draft

  • With the release of our Dev Portal 2.0, we've refreshed our documentation as well!

Anything else?

ping { }

Dev Portal 2.0 updates
- developer-portal.mdx
@bc-terra bc-terra added the need-SME-review A subject matter expert is needed to review. label Apr 21, 2025
| Load | Requested when user launches app |
| Uninstall | Requested when store owner or authorized user clicks `uninstall` |
| Enable multiple users | Optionally allow your app to be accessible to store users other than the owner |
| Remove user callback URL | Requested when a store owner opts to revoke a user’s authorization to use the app |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [remark-lint] reported by reviewdog 🐶
Hard to read sentence (confidence: 6/7) retext-readability retext-readability

| Create | Grants the app access to create data |
| Get | Grants the app access to read specific data |
| Token Login | Allows management of login processes including authentication and session handling |
| Generate Tokens | Allows generation of access tokens used to access storefront or customer account information |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [remark-lint] reported by reviewdog 🐶
Hard to read sentence (confidence: 6/7) retext-readability retext-readability

| Partner Website | URL to your homepage |
| Support Email | Business mail where users can get help with the app |
| Support Website | Used for **Get Support** button in Marketplace |
| Partner ID | Required for submission; assigned to [partners](/docs/start/partner#applying-to-the-technology-partner-program) after approval |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [remark-lint] reported by reviewdog 🐶
Hard to read sentence (confidence: 6/7) retext-readability retext-readability

| --- | --- |
| Storefront type | Indicates whether multi storefront is compatible with the app |
| Multi-location inventory | Indicates whether multi-location inventory is compatible with the app |
| Testing instructions | Instructions needed to test the app thoroughly |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [remark-lint] reported by reviewdog 🐶
Hard to read sentence (confidence: 5/7) retext-readability retext-readability

| Field | Description |
| --- | --- |
| Short app summary | A brief description that shows up in search results |
| Full app description | A broad overview of the app including benefits, use-cases, and other information. Displayed on the app’s detail page in the apps marketplace |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [remark-lint] reported by reviewdog 🐶
Hard to read sentence (confidence: 4/7) retext-readability retext-readability


![App Supported Features](https://storage.googleapis.com/bigcommerce-production-dev-center/images/dev-portal-app-supported-features.png "App Supported Features")
<Callout type="info">
Despite the indication within the editor that Company privacy policy and Company terms of service are optional, they are required for legal reasons and should be included.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [remark-lint] reported by reviewdog 🐶
Hard to read sentence (confidence: 5/7) retext-readability retext-readability

| Field | Description |
| --- | --- |
| Installation guide | A guide for installing the app if there are special considerations the user should take for initial setup |
| User guide | General guide for users, both new and experienced, for using the app |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [remark-lint] reported by reviewdog 🐶
Hard to read sentence (confidence: 4/7) retext-readability retext-readability

- fixed one image that previously showed OAuth scopes instead of the referenced diagram
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need-SME-review A subject matter expert is needed to review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant