Browse Source

docs: add homepage and links to The Anchor Book (#1336)

Paul 3 years ago
parent
commit
7615c7821c
3 changed files with 26 additions and 0 deletions
  1. 1 0
      docs/src/.vuepress/config.js
  2. 2 0
      docs/src/getting-started/introduction.md
  3. 23 0
      docs/src/index.md

+ 1 - 0
docs/src/.vuepress/config.js

@@ -85,6 +85,7 @@ module.exports = {
     ],
 
     nav: [
+      { text: "The Anchor Book", link: "https://book.anchor-lang.com" },
       { text: "Rust", link: "https://docs.rs/anchor-lang/latest/anchor_lang/" },
       { text: "TypeScript", link: "https://project-serum.github.io/anchor/ts/index.html" },
       { text: "GitHub", link: "https://github.com/project-serum/anchor" }

+ 2 - 0
docs/src/getting-started/introduction.md

@@ -1,5 +1,7 @@
 # Introduction
 
+<div style="border: 2px solid red; text-align: center; padding: 10px 10px 10px 10px; box-sizing: border-box"> This documentation is being sunset in favor of <a href="https://book.anchor-lang.com" rel="noopener noreferrer" target="_blank">The Anchor Book</a>. At this point in time, either documentation may contain information that the other does not.</div>
+
 Anchor is a framework for Solana's [Sealevel](https://medium.com/solana-labs/sealevel-parallel-processing-thousands-of-smart-contracts-d814b378192) runtime providing several convenient developer tools.
 
 - Rust crates and eDSL for writing Solana programs

+ 23 - 0
docs/src/index.md

@@ -0,0 +1,23 @@
+---
+home: true
+heroText: Anchor
+tagline: A framework for building Solana programs
+actionText: Get Started →
+actionLink: /getting-started/introduction
+features:
+- title: Security
+  details: Anchor eliminates many footguns of raw Solana programs by default and allows you to add more security checks without disrupting your business logic.
+- title: Code Generation
+  details: (De)Serialization, cross-program invocations, account initialization, and more.
+- title: IDL & Client Generation
+  details: Anchor generates an IDL based on your program and automatically creates a typescript client with it.
+- title: Verifiability
+  details: Anchor programs can be built verifiably, so users know that the on-chain program matches the code base.
+- title: Workspace Management
+  details: The CLI helps you manage workspaces with multiple programs, e2e tests, and more.
+- title: Compatibility
+  details: Anchor programs can interact with all non-anchor programs on Solana.
+
+footer: Apache License 2.0
+---
+<div style="border: 2px solid red; text-align: center; padding: 10px 10px 10px 10px; box-sizing: border-box"> This documentation is being sunset in favor of <a href="https://book.anchor-lang.com" rel="noopener noreferrer" target="_blank">The Anchor Book</a>. At this point in time, either documentation may contain information that the other does not.</div>