Skip to content

Commit

Permalink
Feat: documentation setup with vocs (#75)
Browse files Browse the repository at this point in the history
* chore(deps): add vocs

* ci: update docs scripts

* docs: remove docusaurus docs

* ci: add vocs config

* docs: add sample page

* docs: setup (WIP)

* chore: add ignore path

* chore: update docs scripts

* chore: switch to bun

* ci: update gitignore

* docs: landing page

* docs: add placeholder pages

* fix: baseUrl

* chore(deps): upgrade typescript

* docs: add favicon

* docs: update overview snippet

* docs: add sponsors

* chore: remove bun lock

* docs: update README header

* docs: update og image url

* chore: audit

* docs: move guides folder

* docs: add getting started placeholder

* ci: remove typedoc workflow

* chore: fix docs crash

* docs: re-add docs examples
  • Loading branch information
moritzkirstein authored Mar 19, 2024
1 parent e8ab083 commit dd24dcd
Show file tree
Hide file tree
Showing 242 changed files with 9,712 additions and 56,614 deletions.
51 changes: 0 additions & 51 deletions .github/workflows/typedoc-docusaurus.yml

This file was deleted.

37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,39 @@
# Nautilus
<br />

<p align="center">
<a href="https://nautilus.delta-dao.com">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/deltaDAO/nautilus/raw/feat/vocs/docs/public/logo-dark.svg">
<img alt="nautilus logo" src="https://github.com/deltaDAO/nautilus/raw/feat/vocs/docs/public/logo-light.svg" width="auto" height="60">
</picture>
</a>
</p>

<p align="center">
The Data Economy TypeScript Toolkit
<p>

<p align="center">
<a href="https://www.npmjs.com/package/deltadao/nautilus">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/@deltadao/nautilus?colorA=21262d&colorB=21262d&style=for-the-badge">
<img src="https://img.shields.io/npm/v/@deltadao/nautilus?colorA=f6f8fa&colorB=f6f8fa&style=for-the-badge" alt="Version">
</picture>
</a>
<a href="https://github.com/deltaDAO/nautilus/blob/main/LICENSE">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/l/@deltadao/nautilus?colorA=21262d&colorB=21262d&style=for-the-badge">
<img src="https://img.shields.io/npm/l/@deltadao/nautilus?colorA=f6f8fa&colorB=f6f8fa&style=for-the-badge" alt="Apache-2.0 License">
</picture>
</a>
<a href="https://www.npmjs.com/package/deltadao/nautilus">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/github/actions/workflow/status/deltaDAO/nautilus/release.yml?colorA=21262d&colorB=21262d&style=for-the-badge">
<img src="https://img.shields.io/github/actions/workflow/status/deltaDAO/nautilus/release.yml?colorA=f6f8fa&colorB=f6f8fa&style=for-the-badge" alt="GitHub Actions Workflow Status">
</picture>
</a>
</p>


A typescript library helping to navigate the OCEAN. It enables configurable automated publishing and consumption of assets in any [Ocean Protocol](https://oceanprotocol.com) ecosystem.

Expand Down
20 changes: 0 additions & 20 deletions docs/.gitignore

This file was deleted.

35 changes: 0 additions & 35 deletions docs/README.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/babel.config.js

This file was deleted.

67 changes: 0 additions & 67 deletions docs/docs/Examples/Access.md

This file was deleted.

111 changes: 0 additions & 111 deletions docs/docs/Examples/Compute.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/docs/api/_category_.yml

This file was deleted.

Loading

0 comments on commit dd24dcd

Please sign in to comment.