Skip to content

Commit

Permalink
feat: added support for manual api documentation in markdown before f…
Browse files Browse the repository at this point in the history
…ully adopting openapi documentation
  • Loading branch information
manustays committed Dec 15, 2024
1 parent f2407cd commit 8fed3d0
Show file tree
Hide file tree
Showing 3 changed files with 444 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Eko Platform Services OpenAPI Definition

**Link to the OpenAPI Spec:** https://ekoindia.github.io/openapi-spec/docs/openapi.yaml
**Link to OpenAPI Spec:** https://ekoindia.github.io/openapi-spec/openapi.yaml
**Link to Generated Docs:** https://ekoindia.github.io/openapi-spec


## Working on your OpenAPI Definition
Expand All @@ -23,10 +24,10 @@ Validates the definition.

## Contribution Guide

Below is a sample contribution guide. The tools
in the repository don't restrict you to any
Below is a sample contribution guide. The tools
in the repository don't restrict you to any
specific structure. Adjust the contribution guide
to match your own structure. However, if you
to match your own structure. However, if you
don't have a structure in mind, this is a
good place to start.

Expand All @@ -35,7 +36,7 @@ adjust the file/folder organization.

The `.redocly.yaml` controls settings for various
tools including the lint tool and the reference
docs engine. Open it to find examples and
docs engine. Open it to find examples and
[read the docs](https://docs.redoc.ly/cli/configuration/)
for more information.

Expand Down
Loading

0 comments on commit 8fed3d0

Please sign in to comment.