Rebrand Docusaurus site scaffold from Dyte to OSPI - #452
Open
BrickeVD wants to merge 4 commits into
Open
Conversation
Remove all Dyte video-SDK doc instances, components, dependencies and branding. Repoint docusaurus.config.js at OSPI (title, tagline, url, navbar/footer, doc instances reduced to guides/api-reference/architecture). Switch theme color to pink, add placeholder OSPI wordmark logo + favicon (real brand assets not ready yet), and replace the marketing homepage with a plain OSPI-focused one. Content authoring for guides/api-reference/ architecture (sourced from the real ospi-platform repo) follows in subsequent commits.
Guides, API Reference (13 domain pages) and Architecture (34 ported ADRs + domain model overview) are now populated with real content sourced from the actual ospi-platform repository (README, controllers, DTOs, ADRs) -- endpoints, permissions, request/response shapes and behavioral notes are all pulled from the real source, not invented. Also fixes several leftover Dyte references that broke `npm run build` after the previous rebrand commit (MDXComponents importing deleted components, Footer wrapper importing a removed @docsly/react dependency and a deleted homepage component, DocSidebar/SidebarMenu/SectionsMenu depending on the deleted src/sections.ts). Removes ~47MB of now-unused Dyte marketing/screenshot static assets, dead CSS for the removed SDK navbar dropdown, the docsearch/algolia crawler workflow and scripts, and tidies remaining Dyte references in CODEOWNERS, issue templates, CODE_OF_CONDUCT, cspell.json, robots.txt and _redirects. `npm run build` passes clean.
Replaces the static description of endpoints with a live, per-endpoint reference (request/response schemas + a "Try It" console), generated by docusaurus-plugin-openapi-docs from openapi/ospi-platform.json — an actual OpenAPI 3 document exported from the ospi-platform NestJS backend's own SwaggerModule (101 real paths, 47 real schemas), not hand-written. - Bump @docusaurus/* to ^3.10.0 to satisfy the plugin's peer deps. - New api-reference "Endpoints" sidebar section alongside the existing hand-written domain guides. - README documents how to regenerate openapi/ospi-platform.json when the backend's API surface changes.
Three feature cards (2-then-1 layout, matching the reference site's "Build with Dyte" hero) replace the plain four-item pillar grid at the top of the page. Each card's code panel shows real output instead of a mockup illustration: a checksum-verified OSPI code computed by the actual ospi-code.util.ts algorithm, and request examples using the real DTO field names/enums from ospi-platform.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Remove all Dyte video-SDK doc instances, components, dependencies and branding. Repoint docusaurus.config.js at OSPI (title, tagline, url, navbar/footer, doc instances reduced to guides/api-reference/architecture). Switch theme color to pink, add placeholder OSPI wordmark logo + favicon (real brand assets not ready yet), and replace the marketing homepage with a plain OSPI-focused one. Content authoring for guides/api-reference/ architecture (sourced from the real ospi-platform repo) follows in subsequent commits.
Description
Describe your PR here.
Resolved issues
Closes #1
Before submitting the PR, please take the following into consideration
feat:,fix:,chore:,docs:, orrefactor:.mainbranch.