gobeyondidentity/developer-docs

Source code for Beyond Identity's Developer Docs. Anyone is welcome to contribute.

developer-docs's Issues

[Content issue]: Slack needs to be uppercase in the Support section's description on the homepage of the docs

Add documentation for API Scopes

Add Content to Architecture doc section

[Content issue]: Replace "email" with "Slack" on API documentation homepage

I like that we have multiple link outs to the developer Slack across the documentation. Keeping with this preferred action, replace the support email with a link to our Slack channel instead on the API overview page https://developer-docs-git-docs-staging-beyondidentity.vercel.app/api/v1

Update OpenAPI Yaml (July 11)

Enable npm2yarn for guides doc

Document session management workflow

Looking at the token revocation API. Is the developer supposed to use the token id from list tokens to revoke? Can we make that more clear?

I am thinking through a developer trying to implement the following in an account settings page for their application:

1. As an end user I would like to see a list of my active sessions in my account settings page
2. As an end user I would like to select an active session and revoke it (from my account settings page)

Originally posted by @beyondchojnacki in #226 (comment)

Look into using Redocusaurus to surface API examples

[Crash] Authentication on "Try it Out" experience

I enabled the Try it Out experience on the staging website here. Creating a passkey and viewing passkeys work. When I try to authenticate, there's a crash that occurs. See image below:

Review v1 integration guides for accuracy

Move SSO integration guides to Guides

Final once over and small fixes

Add a guide for sending enrollment email

Document Firefox behavior

Review Okta integration guide

Enable broken link checking and fix anything that's broken

[Content issue]: Send Enrollment Emails would be better categorized under Workflows

One thing is not like the other under "Integration Guides". Unlike the other integration guides, enrollment email send is not a technology that we're integrating with but a workflow that a customer should enable.

Recommendation to move it to "Workflows"

Add content about credential binding jobs and what are Passkeys

Update OpenAPI.yaml from zero repo

Create a Version v1 of docs and Rest API

Add a "What is" page inspired by: https://docsearch.algolia.com/docs/what-is-docsearch/

Feedback on Getting started page

Add ForgeRock integration guide

Hide Guides link

Update passkey storage doc

Remove legacy v0 docs from v1 docs fork

Getting started doc regional link updates

In Step 6 of the Getting Started Guide, there is a step to "Log into the Admin Console, then to get your Tenant ID".

We need to add a separate link for eu and make it clear to use the correct one for region (I was sat requesting credentials, nothing was turning up until I realised this might be the case)

Review v1 remaining content for general accuracy

Go over the content in v1 here:
https://developer-docs-git-v1-beyondidentity.vercel.app/docs/v1/introduction

And create tasks in this project for anything that needs to be updated or removed

Add windows and Mac sections to Getting started doc

Update URL for OpenAPI YAML download

Getting started: Create tabs for different OSes

Update footer links

Remove duplicate Github Link from footer

[Content issue]: NextAuth is now called Auth.js

URL

https://developer.beyondidentity.com/docs/v1/guides/integrate-nextauth

Issue description

NextAuth is becoming Auth.js so our documentation should match the update

Screenshots

No response

Additional Context

No response

Get rid of dependencies for brew and jq

Small fixes to Getting started

CORS issue when Executing API Reference

Does this happen in preview envs only or also in prod?

Getting started doc questions

A few questions I had when reading the getting started doc:

1. What does the example app do? Why?
2. Why is API key creation necessary? (This might be answered once 1 is answered.)
3. How does the example app use Beyond Identity software? What files should I read to understand that? As a developer who wants to use BI to authenticate users to my NodeJS app, I don't know what to do once I've completed the getting started guide.
4. Which of the configuration values that I use in my application should I keep secret? Is my tenant ID a secret?

Test example app in linux

Hide deployment model articles - not ready

Flesh out documentation outline and other fixes

Add a search feature for the entire site

Write an integration guide for Okta for v1

Change link to support to point to Slack

Move SDK's to top level article

Set respectPrefersColorScheme true and default dark mode

Migrate v0 api docs to redocusaurus

[Content issue]: "Products" should link out to developer microsite

The home base for CIAM PLG is the developer microsite. The link should be updated from https://www.beyondidentity.com/products/secure-customers to https://www.beyondidentity.com/developers#/mobile