v1.6.0

What's Changed

• Dependency updates
• Implement two-phase project loading by @ulrikandersen in #683

Full Changelog: 1.5.0...1.6.0

v1.5.0

What's Changed

• Diff sidebar by @oscarlund121 in #607
• Add scroll-to-change navigation from diff sidebar by @ulrikandersen in #634
• Add has-changes indicator for specs in PR branches by @ulrikandersen in #633
• style: improve diff sidebar layout and colors by @ulrikandersen in #635
• fix: pass hasChanges to spec selector for change indicator by @ulrikandersen in #636
• fix: scroll to change works without operationId by @ulrikandersen in #637
• fix: refresh projects when window regains focus by @ulrikandersen in #639
• feat: add loading indicator when refreshing projects by @ulrikandersen in #640
• fix: preserve scroll position when projects refresh by @ulrikandersen in #642
• Fixes loading screen shown below documentation by @simonbs in #649
• Rename project configuration filename in .env.example by @simonbs in #647
• Fixes sidebars not rendering in previous state following refreshes by @simonbs in #648
• Hide diff-related UI when feature is disabled by @ulrikandersen in #651

Full Changelog: 1.4.0...1.5.0

1.4.0

What's Changed

• Bump the react group with 2 updates by @dependabot[bot] in #608
• Bump next-auth from 5.0.0-beta.29 to 5.0.0-beta.30 by @dependabot[bot] in #611
• Bump next from 15.3.4 to 15.5.6 by @dependabot[bot] in #610
• Sets jsx to preserve by @simonbs in #613
• Migrates from next lint to eslint by @simonbs in #614
• Bump the everything-else group across 1 directory with 35 updates by @dependabot[bot] in #612
• Removes GitHub Actions linting by @simonbs in #616
• Updates to Next 16 and Node 24 by @simonbs in #615
• Fixes plus icon in New Project button not centered by @simonbs in #618
• Bump the everything-else group with 12 updates by @dependabot[bot] in #623
• Bump glob from 10.4.5 to 10.5.0 by @dependabot[bot] in #624
• Bump next from 16.0.6 to 16.0.7 by @dependabot[bot] in #625

Full Changelog: 1.3.0...1.4.0

1.3.0

What's Changed

• Replaces swagger-ui-react with unpkg by @simonbs in #587
• Upgrades to React 19 by @simonbs in #588
• feat: add linting for GHA by @SMillerDev in #591
• fix(docs): update readme to mention Framna by @SMillerDev in #593
• Use refreshing state to show loading by @ulrikandersen in #603
• Enhance project caching by @oscarlund121 in #602
• Adds project refresh functionality to context and UI by @oscarlund121 in #605
• Dependency updates

New Contributors

• @SMillerDev made their first contribution in #591
• @oscarlund121 made their first contribution in #602

Full Changelog: 1.2.0...1.3.0

1.2.0

What's Changed

• Bumped dependencies
• Allows specifying default specification via config by @ulrikandersen in #558
• Sort specifications alphabetically by @ulrikandersen in #559
• Only sort repository specifications by @ulrikandersen in #566

Full Changelog: 1.1.1...1.2.0

1.1.1

What's Changed

• Updates dependencies.

Full Changelog: 1.1.0...1.1.1

1.1.0

What's Changed

• Changes background color of selected item by @simonbs in #6
• Adds unit tests for navigation by @simonbs in #8
• Makes editURL optional by @simonbs in #9
• Shows version and specification as path in toolbar by @simonbs in #10
• Fixes crash when no config exists by @simonbs in #11
• Removes openapi suffix from default name by @simonbs in #13
• Makes app icons rounded by @simonbs in #12
• Fixes hooks called multiple times by @simonbs in #14
• Configures ESLint by @simonbs in #17
• Updates Node version in test workflow by @simonbs in #18
• Updates @babel/traverse by @simonbs in #23
• Bump @mui/icons-material from 5.14.13 to 5.14.14 by @dependabot in #24
• Bump eslint-config-next from 13.5.4 to 13.5.6 by @dependabot in #25
• Bump @types/swagger-ui-react from 4.18.1 to 4.18.2 by @dependabot in #26
• Bump @types/jest from 29.5.5 to 29.5.6 by @dependabot in #27
• Bump @types/node from 20.8.2 to 20.8.7 by @dependabot in #28
• Bump next from 13.5.4 to 13.5.6 by @dependabot in #29
• Reduces re-renderings when loading documentation by @simonbs in #30
• Handles Auth0 login errors by forcing user to logout by @simonbs in #31
• Bump @types/react-dom from 18.2.10 to 18.2.14 by @dependabot in #32
• Bump core-js from 3.33.0 to 3.33.1 by @dependabot in #36
• Bump styled-components from 6.0.8 to 6.1.0 by @dependabot in #35
• Bump @mui/material from 5.14.13 to 5.14.14 by @dependabot in #33
• Bump @types/react from 18.2.25 to 18.2.31 by @dependabot in #34
• Deletes unused useForceUpdate.ts by @simonbs in #37
• Bump yaml from 2.3.2 to 2.3.3 by @dependabot in #42
• Bump @typescript-eslint/eslint-plugin from 6.8.0 to 6.9.0 by @dependabot in #41
• Bump @typescript-eslint/parser from 6.8.0 to 6.9.0 by @dependabot in #40
• Bump @types/node from 20.8.7 to 20.8.8 by @dependabot in #39
• Stores tokens in Redis by @simonbs in #38
• Logs out the user when GitHub token not found by @simonbs in #43
• Validates OAuthToken schema with zod by @simonbs in #44
• Restructures project by @simonbs in #45
• Adds unit tests for URL utils by @simonbs in #46
• Constructs URL from SHAPE_DOCS_BASE_URL by @simonbs in #47
• Caches projects on server-side by @simonbs in #52
• Logs out user when receiving HTTP 401 by @simonbs in #53
• Shows selected project in the window title by @simonbs in #56
• Replaces URL to match selected version and specification by @simonbs in #57
• Fixes linting warning by @simonbs in #59
• Makes the drawer responsive by @simonbs in #60
• Press the Duck to go home by @ulrikandersen in #61
• Delete session cookie upon force logout by @ulrikandersen in #62
• Optimizes the app for mobile by @simonbs in #63
• Fixes linting warnings by @simonbs in #64
• Feature/add-image-caching by @valeriu-nicolas-vancea in #65
• Fixes clicking duck to go home by @simonbs in #66
• Automatically closes sidebar on mobile by @simonbs in #67
• Fixes layout issue of menu button by @simonbs in #68
• Fixes comments not posted when processing web hook by @simonbs in #69
• Prioritizes selecting a project over entering loading or error states by @simonbs in #71
• Considers page to be loading as long as client is loading by @simonbs in #72
• Refactors project selection by @simonbs in #73
• Fixes layout of error message by @simonbs in #74
• Shows loading indicator by @simonbs in #75
• Deploy to production by @simonbs in #76
• Allows sidebar to be closed when project ID exists by @simonbs in #77
• Hides expand/collapse button when mobileToolbar is undefined by @simonbs in #78
• Removes unused files by @simonbs in #79
• Always closes sidebar animated on mobile by @simonbs in #80
• Linting warnings causes workflow to fail by @simonbs in #82
• Hides expand/collapse mobile toolbar on desktop by @simonbs in #81
• Embeds Redoc viewer in iframe by @simonbs in #83
• Deploy to production by @simonbs in #84
• Fixes loading indicator layout by @simonbs in #85
• Deploy to production by @simonbs in #86
• Fixes expand/collapse button appearing stretched by @simonbs in #87
• Removes horizontal scroll indicators from loading wrapper by @simonbs in #88
• Deploy to production by @simonbs in #89
• Adds Shape logo to be used with Auth0 by @simonbs in #91
• Deploy to production by @simonbs in #92
• Removes Shape logo by @simonbs in #93
• Shapes project icons as a squircle by @simonbs in #94
• Updates styling of selected and hover states in menu by @simonbs in #95
• Refreshes the design by @simonbs in #96
• Fixes appearance of loading states by @simonbs in #97
• Removes default rounding of paper by @simonbs in #98
• Uses media query to detect if hovering is supported by @simonbs in #99
• Bump swagger-ui-react from 5.9.0 to 5.9.1 by @dependabot in #100
• Bump @mui/material from 5.14.14 to 5.14.15 by @dependabot in #101
• Bump redoc from 2.1.2 to 2.1.3 by @dependabot in #104
• Bump auth0 from 4.0.1 to 4.0.2 by @dependabot in #103
• Bump @types/node from 20.8.8 to 20.8.9 by @dependabot in #102
• Uses FontAwesome icons by @simonbs in #105
• Styles the Select component by @simonbs in #106
• Updates fonts by @simonbs in #107
• Redesigns sidebar to be more harmonic by @simonbs in #108
• Deploy to production by @simonbs in #109
• Fixes hover effect showing while button not clickable by @simonbs in #110
• Deploy to production by @simonbs in #111
• Ensures exclusive access to the access token and refresh token by @simonbs in #90
• Deploy to production by @simonbs in #112
• Refreshes access token only when receiving HTTP 401 from GitHub by @simonbs in #113
• Add missing max-age cache directive by @ulrikandersen in #114
• Auth optimisations & Image caching by @ulrikandersen in #116
• Adds static images by @simonbs in #117
• Deploy to production by @simonbs in #118
• Bump tailwindcss from 3.3.3...

🚀 1.0

At this year’s FramnaCon, our first company-wide conference that took place in Obonjan, Croatia, we open-sourced Framna Docs, an internal tool for centralizing API documentation and facilitating spec-driven development.

As an agency collaborating with numerous partners, we have developed—and will continue to develop—many mobile apps and backend services that rely on APIs to exchange data. Over the years, we've noticed that API documentation often becomes fragmented across various platforms like Confluence, Notion, Postman, GitHub, and even Google Sheets. This fragmentation makes it challenging to find the right documentation when needed and leads to inconsistencies in format, making it even harder to navigate and understand the documentation.

We set out to tackle this challenge with Framna Docs in October 2023 and have been using it daily at Shape for almost a year. Today, we’re excited to announce that Framna Docs is now open-source.