Skip to content
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

Uses "centralizes" over "collects" #371

Merged
merged 2 commits into from
Sep 17, 2024
Merged

Conversation

simonbs
Copy link
Contributor

@simonbs simonbs commented Sep 17, 2024

Specifies that Framna Docs centralizes documentation rather than collects it. I think the latter makes it sound as though Framna Docs shows documentation from a plethora of sources, whereas, in reality, it's only two: GitHub repositories and remotely hosted OpenAPI specs.

Instead, I suggest we use the word "centralizes," which I think better reflects our original goal of having a single place to find documentation for APIs, even if it means we need to rewrite the documentation for those APIs as OpenAPI specifications.

Copy link
Contributor

@ulrikandersen ulrikandersen left a comment

Choose a reason for hiding this comment

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

Resonates with me. Aligns with how we've been talking about centralising documentation.

@simonbs simonbs merged commit bda8efd into develop Sep 17, 2024
5 checks passed
@simonbs simonbs deleted the centralizes-instead-of-collects branch September 17, 2024 05:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants