📝 chore: New documentation (#1230)

* feat: New documentation * fix: format * chore: API documentation * fix: build * fix: build v2 * fix: minor fixes
Synthetixio · Oct 13, 2024 · 5973755 · 5973755
1 parent e27d20a
commit 5973755
Show file tree

Hide file tree

Showing 52 changed files with 4,469 additions and 1,134 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -21,7 +21,7 @@ export default defineConfig({
  // https://vitepress.dev/reference/default-theme-config
  nav: [
  { text: 'Docs', link: '/docs/getting-started' },
- { text: 'API', link: '/api/' },
+ { text: 'API', link: '/api/index/' },
  { text: 'Examples', link: 'https://github.com/Synthetixio/synpress/tree/new-dawn/examples' },
  {
  text: pkg.version,

diff --git a/docs/.vitepress/sidebar.ts b/docs/.vitepress/sidebar.ts
@@ -7,7 +7,14 @@ export const sidebar: DefaultTheme.Sidebar = {
  text: 'Introduction',
  items: [
  { text: 'Why Synpress?', link: '/docs/introduction' },
- { text: 'Getting Started', link: '/docs/getting-started' },
+ {
+ text: 'Getting Started',
+ link: '/docs/getting-started',
+ items: [
+ { text: 'Start with Playwright', link: '/docs/setupPlaywright' },
+ { text: 'Start with Cypress', link: '/docs/setupCypress' }
+ ]
+ },
  { text: 'Migration Guide', link: '/docs/migration-guide' },
  { text: 'TypeScript', link: '/docs/typescript' },
  { text: 'Platform Compatibility', link: '/docs/platform-compatibility' },

diff --git a/docs/api/classes/EthereumWalletMock.md b/docs/api/classes/EthereumWalletMock.md