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

[DOCS]chore: remove the docs subdir #1015

Merged
merged 15 commits into from
Oct 11, 2023
  •  
  •  
  •  
2 changes: 2 additions & 0 deletions .changeset/great-berries-sell.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
31 changes: 17 additions & 14 deletions packages/apps/docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
# generated resources
src/_generated
public/sitemap.xml
src/pages/docs/kadena/kadenajs
src/pages/docs/kadena/client
src/pages/docs/pact/cli
src/pages/docs/pact/pactjs-test-project/api
src/pages/docs/pact/pactjs-test-project/project-api
src/pages/docs/build/kda-cli
src/pages/docs/build/cryptography-utils
src/pages/docs/pact/pactjs
src/pages/docs/pact/pactjs-generator
src/pages/docs/kadena/client-examples
src/pages/docs/build/cookbook/cookbook
src/pages/docs/chainweb/stream-client
src/pages/docs/chainweb/node-client
src/pages/docs/chainweb/js-bindings
src/pages/kadena/kadenajs
src/pages/kadena/client
src/pages/pact/cli
src/pages/pact/pactjs-test-project/api
src/pages/pact/pactjs-test-project/project-api
src/pages/build/kda-cli
src/pages/build/cryptography-utils
src/pages/pact/pactjs
src/pages/pact/pactjs-generator
src/pages/kadena/client-examples
src/pages/build/cookbook/cookbook
src/pages/chainweb/stream-client
src/pages/chainweb/node-client
src/pages/chainweb/js-bindings


src/pages/docs

next-env.d.ts
.env.local
21 changes: 6 additions & 15 deletions packages/apps/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,22 @@
"scripts": {
"7d": "npx 7d pinecone-create-index --index kda-docs --environment asia-northeast1-gcp",
"7d:clear": "npx 7d pinecone-clear-namespace --namespace kda-docs",
"7d:ingest": "npx 7d ingest --files 'src/pages/docs/**/*.md' --files 'src/pages/docs/**/*.mdx' --files 'src/specs/**/*.json' --namespace kda-docs",
"7d:ingest": "npx 7d ingest --files 'src/pages/**/*.md' --files 'src/pages/**/*.mdx' --files 'src/specs/**/*.json' --namespace kda-docs",
"7d:ingest-algolia-dev": "pnpm run build:scripts && pnpm run algolia-dev",
"7d:ingest-algolia-prod": "pnpm run build:scripts && pnpm run algolia-prod",
"7d:query": "npx 7d",
"algolia-dev": "ALGOLIA_INDEX_NAME=docs_website_dev OPENAI_API_KEY=dummy-key121 npx 7d ingest --files 'src/pages/docs/**/*.md' --files 'src/pages/docs/**/*.mdx' --files 'src/specs/**/*.json' --db algolia --skip-embeddings --dry-run",
"algolia-prod": "ALGOLIA_INDEX_NAME=docs_website_prod OPENAI_API_KEY=dummy-key121 npx 7d ingest --files 'src/pages/docs/**/*.md' --files 'src/pages/docs/**/*.mdx' --files 'src/specs/**/*.json' --db algolia --skip-embeddings",
"algolia-dev": "ALGOLIA_INDEX_NAME=docs_website_dev OPENAI_API_KEY=dummy-key121 npx 7d ingest --files 'src/pages/**/*.md' --files 'src/pages/**/*.mdx' --files 'src/specs/**/*.json' --db algolia --skip-embeddings --dry-run",
"algolia-prod": "ALGOLIA_INDEX_NAME=docs_website_prod OPENAI_API_KEY=dummy-key121 npx 7d ingest --files 'src/pages/**/*.md' --files 'src/pages/**/*.mdx' --files 'src/specs/**/*.json' --db algolia --skip-embeddings",
"build": "pnpm run build:scripts && next build",
"build:blogAuthorInfo": "node src/scripts/createBlogAuthors.mjs",
"build:brokenLinks": "node src/scripts/detectBrokenLinks.mjs",
"build:checkForHeaders": "node src/scripts/checkForHeaders.mjs && prettier ./src/pages/docs --write",
"build:copyFavIcons": "rimraf ./public/assets/favicons && node ./src/scripts/copyFavIcons.mjs",
"build:createSitemap": "node ./src/scripts/createSitemap.mjs && prettier ./public/sitemap.xml --write",
"build:createSpecJson": "node ./src/scripts/createSpec.mjs && prettier ./src/specs/**/*.json --write",
"build:createtree": "node ./src/scripts/getdocstree.mjs && prettier ./src/_generated/menu.mjs --write",
"build:importReadMe": "node ./src/scripts/importReadme.mjs && prettier ./src/pages/docs --write",
"build:next": "pnpm run build:scripts && next build",
"build:scripts": "pnpm run build:importReadMe && pnpm run build:createtree && pnpm run build:createSpecJson && pnpm run build:brokenLinks && pnpm run build:checkForHeaders && pnpm run build:blogAuthorInfo && pnpm run build:createSitemap && pnpm run build:copyFavIcons",
"build:storybook": "pnpm run build:createtree && storybook build",
"build:scripts": "node ./src/scripts/build.mjs",
"build:storybook": "pnpm run build:scripts && storybook build",
"chromatic": "chromatic -b build:storybook",
"cypress:ci": "NEXT_PUBLIC_APP_DEV=test start-server-and-test dev http://localhost:3000 cypress:run",
"cypress:cilocal": "NEXT_PUBLIC_APP_DEV=test start-server-and-test dev http://localhost:3000 cypress:open",
"cypress:open": "percy exec -- cypress open",
"cypress:run": "percy exec -- cypress run",
"dev": "pnpm run build:scripts && next dev",
"dev": "pnpm run build:scripts && next dev",
"format": "pnpm run --sequential /^format:.*/",
"format:lint": "pnpm run lint:src --fix",
"format:src": "prettier . --cache --write",
Expand Down Expand Up @@ -115,7 +107,6 @@
"prettier": "~3.0.0",
"prettier-plugin-packagejson": "^2.4.5",
"recursive-copy": "^2.0.14",
"rimraf": "~5.0.1",
"start-server-and-test": "~2.0.0",
"storybook": "^7.4.0",
"storybook-addon-next-router": "~4.0.2",
Expand Down
Empty file.
4 changes: 2 additions & 2 deletions packages/apps/docs/src/hooks/useGetBlogs/utils.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type { IAuthorInfo, IMenuData } from '@/Layout';
import { compareDesc } from '@/utils/dates';
import { getAuthorData } from '@/utils/staticGeneration/getData.mjs';
import { getAuthorData } from '@/utils/staticGeneration/getJsonData.mjs';

export interface IIBlogLoadOptions {
authorId?: string;
Expand All @@ -19,7 +19,7 @@ export const getInitBlogPosts = (
limit: number,
{ authorId, year, tagId }: IIBlogLoadOptions = {},
): IMenuData[] => {
const STARTBRANCH = '/docs/blogchain';
const STARTBRANCH = '/blogchain';

let posts: IMenuData[] = [];
const startBranch = menuData.find(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Burget.
Also community member Konrad Scorciapino (“konr” on github) made heroic docs
updates. Remember, in a LISP the docs follow the code, don’t forget you can get
full docs on a function right from the interpreter and not scramble for the
[language reference](/docs/pact/reference)! Here’s konr’s corrected docs for
[language reference](/pact/reference)! Here’s konr’s corrected docs for
with-read-default:

```pact
Expand All @@ -38,7 +38,7 @@ with-read-default:
```

`brew upgrade kadena-io/pact/pact` to get the goodness or head over to the
[download page](/docs/pact).
[download page](/pact).

## Changelog

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ reviewing the [whitepaper](https://kadena.io/docs/chainweb-v15.pdf)._

_For some recent (Oct 2018) follow-ups on security and addressing assumptions
and misunderstandings about Kadena’s public blockchain, check out our
[post](/docs/blogchain/2018/security-kadena-chainweb-blockchain-2018-11-01)._
[post](/blogchain/2018/security-kadena-chainweb-blockchain-2018-11-01)._

## Frequently Asked Tech Questions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ legacy and integrity of Bitcoin’s proof-of-work protocol. Chainweb is designed
to give blockchain scalability AND security through its multi-chain
configuration; we believe it is the first of its kind. For more about Chainweb,
check out our
[101/FAQ](/docs/blogchain/2019/all-about-chainweb-101-and-faqs-2019-02-01) and
read the [whitepaper](https://kadena.io/docs/chainweb-v15.pdf).
[101/FAQ](/blogchain/2019/all-about-chainweb-101-and-faqs-2019-02-01) and read
the [whitepaper](https://kadena.io/docs/chainweb-v15.pdf).

**How can I participate in testnet?** Beginning with v1 and v2, our testnet will
become open to the public to participate in the network. v0 is private but open
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ layout: blog
# Announcing Pact 3.0

> _UPDATE: Pact 3.1 is now released! Read more on the
> [latest updates here](/docs/blogchain/2019/pact-3-1-is-unleashed-2019-08-22)._
> [latest updates here](/blogchain/2019/pact-3-1-is-unleashed-2019-08-22)._

At Kadena, smart contract technology is something we’re very passionate about —
so we’re excited to
Expand All @@ -31,7 +31,7 @@ in both public and private blockchains.
In this post, we’re going to focus on three new and related features we’ve
shipped with Pact 3.0: **Capabilities**, **Module Governance**, and **Guards**,
and how our
**[Formal Verification](/docs/blogchain/2018/pact-formal-verification-for-blockchain-smart-contracts-done-right-2018-05-11)**
**[Formal Verification](/blogchain/2018/pact-formal-verification-for-blockchain-smart-contracts-done-right-2018-05-11)**
system can help you eliminate bugs. Other major enhancements, like _integrated
SPV support_ and \*namespaces\*, will be covered in future posts.

Expand Down Expand Up @@ -98,7 +98,7 @@ Another new feature in Pact turns something that was already awesome —
upgradeable smart contracts controlled by keysets —into a game changer:
**generalized module governance**. Now you can implement any governance scheme
imaginable, right in your smart contract code, and leverage
[Formal Verification](/docs/blogchain/2018/pact-formal-verification-for-blockchain-smart-contracts-done-right-2018-05-11)
[Formal Verification](/blogchain/2018/pact-formal-verification-for-blockchain-smart-contracts-done-right-2018-05-11)
to ensure it does what you want.

Before Pact 3.0, defining a module required the definition of a keyset, which is
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ layout: blog

# FAQ for Kadena’s Public Blockchain

[Kadena has released mainnet mining](/docs/blogchain/2019/kadena-releases-mainnet-mining-and-announces-token-sale-2019-11-04)
[Kadena has released mainnet mining](/blogchain/2019/kadena-releases-mainnet-mining-and-announces-token-sale-2019-11-04)
to the public, inviting the mining community to begin solving blocks on the
Kadena public blockchain. Kadena’s network has come alive with activity as
miners from all over the world participate on the Kadena network.
Expand Down Expand Up @@ -45,7 +45,7 @@ on for more information.
## Where can I find more information about Kadena tokens?

Read the
[token economics breakdown](/docs/blogchain/2019/the-kadena-token-economic-model-2019-10-30)
[token economics breakdown](/blogchain/2019/the-kadena-token-economic-model-2019-10-30)
for more information on the Kadena token model.

**What hashing algorithm does Kadena use?**
Expand Down Expand Up @@ -123,4 +123,4 @@ over to our
touch with Kadena through
[Discord](https://discordapp.com/invite/bsUcWmX?utm_source=tropyc) or by
following announcements shared on [Twitter](https://twitter.com/kadena_io) and
[Medium](/docs/blogchain).
[Medium](/blogchain).
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Kadena is a braided, PoW network currently in testnet. Based on Bitcoin’s PoW
protocol, Kadena hash-links multiple chains to provide additional security and
throughput. For more resources on understanding Kadena’s public blockchain,
refer to our [whitepaper](https://kadena.io/docs/chainweb-v15.pdf) and
[101 blog post](/docs/blogchain/2019/all-about-chainweb-101-and-faqs-2019-02-01).
[101 blog post](/blogchain/2019/all-about-chainweb-101-and-faqs-2019-02-01).

![A ten-chain configuration of Kadena’s public blockchain, showing how merkle roots are propagated across chains at different blockheights.](/assets/blog/0_AgUQ6JQqbza3urwU.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ card.
### Hybrid Example 3: I run a company that wants to monetize our excess capacity and share our services with others.

We’ve called this concept the
[smart contract sharing economy](/docs/blogchain/2018/blockchain-future-smart-contract-sharing-economy-2018-12-17).
[smart contract sharing economy](/blogchain/2018/blockchain-future-smart-contract-sharing-economy-2018-12-17).
It allows individuals and small businesses to gain access to services that are
normally too costly for them to perform on their own. One example involves
fashion startup Rent the Runway (RTR), which has the largest dry cleaning
Expand All @@ -152,18 +152,18 @@ Kadena’s goal with hybrid blockchain is to empower entrepreneurs and enterpris
to _build better blockchain apps_, ones that can scale with growing success and
that people can trust for keeping their money & data safe.

1. **[Kadena Scalable Permissioned Blockchain](/docs/blogchain/2019/scalablebft-kadenas-private-blockchain-101-2019-03-09)
1. **[Kadena Scalable Permissioned Blockchain](/blogchain/2019/scalablebft-kadenas-private-blockchain-101-2019-03-09)
—** Enterprise-ready permissioned blockchain. Community Edition available on
[AWS](http://kadena.io/aws) and [Azure](http://kadena.io/azure) for free.

2. **[Kadena Public Blockchain](/docs/blogchain/2019/all-about-chainweb-101-and-faqs-2019-02-01)
2. **[Kadena Public Blockchain](/blogchain/2019/all-about-chainweb-101-and-faqs-2019-02-01)
—** Scalable Proof of Work public blockchain. Currently in testnet for a
planned launch in Winter 2019.

3. **[Pact](/docs/blogchain/2019/safer-smarter-contracts-with-pact-2019-02-20)**
Simple and safe smart contract language (open source). Easy to learn with
3. **[Pact](/blogchain/2019/safer-smarter-contracts-with-pact-2019-02-20)**
Simple and safe smart contract language (open source). Easy to learn with
industry-leading security features like user code
[Formal Verification](/docs/blogchain/2018/pact-formal-verification-for-blockchain-smart-contracts-done-right-2018-05-11).
[Formal Verification](/blogchain/2018/pact-formal-verification-for-blockchain-smart-contracts-done-right-2018-05-11).
Pact facilitates interoperability between Kadena’s permissioned and public
blockchain.

Expand All @@ -172,9 +172,9 @@ that people can trust for keeping their money & data safe.
- Spin up our Chainweb testnet [binary](http://kadena.io/testnetbinary) and
check out our new [public dashboard](http://kadena.io/dashboard)!

- Follow us on [Medium](/docs/blogchain) and
[Twitter](http://twitter.com/kadena_io) for announcements and updates about
our upcoming public blockchain mainnet launch.
- Follow us on [Medium](/blogchain) and [Twitter](http://twitter.com/kadena_io)
for announcements and updates about our upcoming public blockchain mainnet
launch.

- Go through a [Pact Beginner Tutorial](http://pactlang.org/), or try
[Pact in your browser](http://pact.kadena.io/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ the Tendermint protocol, the only fully open source permissioned blockchain with
a proven consensus protocol. The Tendermint protocol already supports $5 billion
in value from companies like Binance and Cosmos. Kadenamint brings blockchain
developers the
[best smart contract language](/docs/blogchain/2019/safer-smarter-contracts-with-pact-2019-02-20)
[best smart contract language](/blogchain/2019/safer-smarter-contracts-with-pact-2019-02-20)
available and further establishes Pact as the industry standard.

## Why is Kadenamint important?
Expand All @@ -45,7 +45,7 @@ Kadenamint will allow for rapid implementation of apps in a safer way.
Entrepreneurs and enterprises alike will have a configuration-free and
completely open source smart contract language for business applications.
Kadenamint brings the power of user-code
[Formal Verification](/docs/blogchain/2018/pact-formal-verification-for-blockchain-smart-contracts-done-right-2018-05-11),
[Formal Verification](/blogchain/2018/pact-formal-verification-for-blockchain-smart-contracts-done-right-2018-05-11),
proper multi-signature features and full capabilities to Tendermint.

## What people are saying about Kadenamint:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ systems and exchange backbones for the financial industry, including as leader
of the emerging technology group at JP Morgan. Stuart is the creator of Kadena’s
smart contract language, [Pact](http://pact.kadena.io), the first open-source
smart contract languages with
[formal verification](/docs/blogchain/2018/pact-formal-verification-for-blockchain-smart-contracts-done-right-2018-05-11)
[formal verification](/blogchain/2018/pact-formal-verification-for-blockchain-smart-contracts-done-right-2018-05-11)
built-in.

**[Ronghui Gu](https://www.linkedin.com/in/guronghui/), Co-founder @ Certik:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Some highlights from Monica’s segment on Bloomberg TV:
pick up your prescription, you can trust that it has been verified along the
chain.” For more on what a hybrid blockchain can do to unlock trapped
liquidity,
_**[read Kadena CEO Will Martino’s post on the Blockchain Sharing Economy](/docs/blogchain/2018/blockchain-future-smart-contract-sharing-economy-2018-12-17)**_
_**[read Kadena CEO Will Martino’s post on the Blockchain Sharing Economy](/blogchain/2018/blockchain-future-smart-contract-sharing-economy-2018-12-17)**_

- **Facebook’s stablecoin**: “This represents another company that has large
institutional value demonstrating that they think blockchain is a way for them
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ the cost and time-to-market associated with the on-premise installation of other
blockchain solutions today.

As the first blockchain offering on Microsoft Azure Marketplace to offer
[Formal Verification](/docs/blogchain/2018/pact-formal-verification-for-blockchain-smart-contracts-done-right-2018-05-11),
[Formal Verification](/blogchain/2018/pact-formal-verification-for-blockchain-smart-contracts-done-right-2018-05-11),
Kadena’s scalable solution enables enterprises to efficiently transact and share
data in a secure and decentralized manner. Our existing blockchain clients
include $3 billion asset manager
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,10 @@ innovative work we’re doing across industries.
branding should too.

This year is going to be an exciting year where we bring
[Chainweb](/docs/blogchain/2019/all-about-chainweb-101-and-faqs-2019-02-01), our
[Chainweb](/blogchain/2019/all-about-chainweb-101-and-faqs-2019-02-01), our
public proof-of-work protocol, into testnet and then launch. You may have
checked out our
**[recent roadmap](/docs/blogchain/2019/kadenas-roadmap-to-a-hybrid-blockchain-platform-2019-03-14)**,
**[recent roadmap](/blogchain/2019/kadenas-roadmap-to-a-hybrid-blockchain-platform-2019-03-14)**,
or heard about our new
**[blockchain-as-a-service on AWS Marketplace](http://fortune.com/2019/01/23/blockchain-aws-kadena/)**.
This is just the beginning, and we’re excited to share the rest of the journey
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ A private (also known as a permissioned) blockchain is used for cases where you
want the benefits of having a decentralized database, but need the security of
knowing exactly who the participants are in your network. Private blockchains
chains
[do not use “mining”](/docs/blogchain/2019/why-mining-private-blockchains-dont-mix-2019-02-06),
[do not use “mining”](/blogchain/2019/why-mining-private-blockchains-dont-mix-2019-02-06),
unlike public blockchains.

Kadena’s private blockchain has been used in production by companies in
Expand All @@ -79,7 +79,7 @@ other blockchains cannot? Consider:
benefits of a blockchain.

- The opportunity to
[hybridize your private blockchain with a scalable, public chain](/docs/blogchain/2018/blockchain-future-smart-contract-sharing-economy-2018-12-17)
[hybridize your private blockchain with a scalable, public chain](/blogchain/2018/blockchain-future-smart-contract-sharing-economy-2018-12-17)
to unlock trapped liquidity.

Wondering what blockchain can do for your industry? Ben Jessel explains how
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ available tools.
### How are Kadena Accounts Structured?

We’ve written up a
[Beginner’s Guide to Accounts](/docs/blogchain/2020/beginners-guide-to-kadena-accounts-keysets-2020-01-14)
[Beginner’s Guide to Accounts](/blogchain/2020/beginners-guide-to-kadena-accounts-keysets-2020-01-14)
in the Kadena blockchain, but let’s do a whirlwind tour here just to refresh.
The Kadena blockchain is unique in the sense that each chain is a separate
blockchain for which a global consensus is maintained, and there is no global
Expand Down Expand Up @@ -421,7 +421,7 @@ will choose whether to use `coin.transfer`, `coin.transfer-create`, or
`coin.transfer-crosschain` depending on that context. It will even automate the
previously manual step of constructing an SPV proof in the case of a cross-chain
transfer. We’ve written up a
[thorough tutorial ](/docs/blogchain/2020/do-anything-on-the-kadena-blockchain-with-a-single-tool-2020-02-21)to
[thorough tutorial ](/blogchain/2020/do-anything-on-the-kadena-blockchain-with-a-single-tool-2020-02-21)to
help you understand all of the snazzy features available in Chainweaver.

### Additional Wallet Options
Expand Down
Loading