Skip to content

Commit

Permalink
docs: remove app/web, improve docs structure
Browse files Browse the repository at this point in the history
  • Loading branch information
solidsnakedev committed Mar 5, 2024
1 parent 3d4bb1b commit fdf9c42
Show file tree
Hide file tree
Showing 25 changed files with 63 additions and 745 deletions.
3 changes: 2 additions & 1 deletion apps/docs/next.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
const withNextra = require('nextra')({
theme: 'nextra-theme-docs',
themeConfig: './theme.config.jsx'
themeConfig: './theme.config.jsx',
defaultShowCopyCode: true
})

module.exports = withNextra()
Expand Down
3 changes: 1 addition & 2 deletions apps/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,12 @@
"version": "1.0.0",
"private": true,
"scripts": {
"dev": "next dev --port 3001",
"dev": "next dev",
"build": "next build",
"start": "next start",
"lint": "eslint . --max-warnings 0"
},
"dependencies": {
"@repo/ui": "workspace:*",
"next": "^14.0.4",
"nextra": "^2.13.4",
"nextra-theme-docs": "^2.13.4",
Expand Down
4 changes: 4 additions & 0 deletions apps/docs/pages/Acknowledgements.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Acknowledgements

Lucid owes its origins to Spacebudz [alessandrokonrad](https://github.com/alessandrokonrad), who initially developed it as an open-source offering.
In late 2023, when maintenance ceased, Anastasia Labs and others stepped up to the challenge of preserving and enhancing the codebase.
6 changes: 6 additions & 0 deletions apps/docs/pages/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"index": "Quickstart",
"install": "Installing Lucid",
"getting-started": "Getting Started",
"contact": "Contact Us"
}
1 change: 0 additions & 1 deletion apps/docs/pages/about/legal.md

This file was deleted.

12 changes: 12 additions & 0 deletions apps/docs/pages/getting-started/instantiate-lucid.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Instantiate Lucid

Lucid can be used with or without a blockchain provider, which allows you to query data and submit transactions. It's recommended to select a provider and network when using Lucid. Lucid currently supports the Mainnet, Preprod, and Preview networks, with Mainnet being the default selection if no network is specified. Throughout the entire docs we are making use of the Preprod network.

```typescript
import { Blockfrost, Lucid } from "lucid-evolution";

const lucid = await Lucid.new(
new Blockfrost("https://cardano-preprod.blockfrost.io/api/v0", "<projectId>"),
"Preprod",
);
```
7 changes: 6 additions & 1 deletion apps/docs/pages/index.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Welcome to Lucid Evolution

Hello, world!
import { Callout } from 'nextra/components'

<Callout type="warning" emoji="⚠️">
Please note that the documentation is currently under construction and some sections may be incomplete or subject to changes.
We are working hard to provide you with comprehensive and accurate information.
</Callout>
20 changes: 20 additions & 0 deletions apps/docs/pages/install.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { Callout } from 'nextra/components'
import { Tabs } from 'nextra/components'

# Install
Lucid works with yarn, npm, and pnpm on the following operating systems:

- macOS darwin 64-bit (Intel), ARM 64-bit (Apple Silicon)
- Linux 64-bit, ARM 64-bit
- Windows 64-bit, ARM 64-bit

<Callout type="warning" emoji="⚠️">
Use with caution, this library is currently in beta testing phase. Your feedback is greatly appreciated.
</Callout>


<Tabs items={['pnpm', 'npm', 'yarn']}>
<Tabs.Tab>**pnpm**: Fast, disk space efficient package manager. </Tabs.Tab>
<Tabs.Tab>**npm** is a package manager for the JavaScript programming language.</Tabs.Tab>
<Tabs.Tab>**Yarn** is a software packaging system.</Tabs.Tab>
</Tabs>
12 changes: 12 additions & 0 deletions apps/docs/pages/license.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# License

`Lucid evolution library is released under the MIT license`

The MIT License (MIT)
Copyright © 2024 Anastasia Labs

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
9 changes: 0 additions & 9 deletions apps/web/.eslintrc.js

This file was deleted.

28 changes: 0 additions & 28 deletions apps/web/README.md

This file was deleted.

Binary file removed apps/web/app/favicon.ico
Binary file not shown.
50 changes: 0 additions & 50 deletions apps/web/app/globals.css

This file was deleted.

22 changes: 0 additions & 22 deletions apps/web/app/layout.tsx

This file was deleted.

Loading

0 comments on commit fdf9c42

Please sign in to comment.