Unverified Commit f9a27032 authored by Hong Minhee's avatar Hong Minhee
Browse files

Reorganize tutorial

parent 14a349ff

docs/.vitepress/config.mts

+14 −6
Original line number Diff line number Diff line
@@ -46,6 +46,18 @@ if (process.env.PLAUSIBLE_DOMAIN) { 
  ];

}



const TUTORIAL = {

  text: "Tutorials",

  items: [

    {

      text: "Quick demo",

      link: "https://dash.deno.com/playground/fedify-demo",

    },

    { text: "Learning the basics", link: "/tutorial/basics.md" },

  ],

  activeMatch: "/tutorial",

};



const MANUAL = {

  text: "Manual",

  items: [
@@ -75,8 +87,8 @@ export default withMermaid(defineConfig({ 
    nav: [

      { text: "Home", link: "/" },

      { text: "Installation", link: "/install.md" },

      { text: "Tutorial", link: "/tutorial.md" },

      { text: "CLI", link: "/cli.md" },

      TUTORIAL,

      MANUAL,

      { text: "API reference", link: "https://jsr.io/@fedify/fedify" },

      ...extraNav,
@@ -84,16 +96,12 @@ export default withMermaid(defineConfig({ 


    sidebar: [

      { text: "What is Fedify?", link: "/intro.md" },

      {

        text: "Quick demo",

        link: "https://dash.deno.com/playground/fedify-demo",

      },

      { text: "Installation", link: "/install.md" },

      { text: "In-depth tutorial", link: "/tutorial.md" },

      {

        text: "CLI toolchain",

        link: "/cli.md",

      },

      TUTORIAL,

      MANUAL,

      {

        text: "Examples",

docs/index.md

+1 −1
Original line number Diff line number Diff line
@@ -24,7 +24,7 @@ hero: 
    link: https://dash.deno.com/playground/fedify-demo

  - theme: alt

    text: Tutorial

    link: /tutorial.md

    link: /tutorial/basics.md

  - theme: alt

    text: GitHub

    link: https://github.com/dahlia/fedify

docs/tutorial.md→docs/tutorial/basics.md

+3 −6
Original line number Diff line number Diff line
@@ -3,13 +3,10 @@ description: >- 
  This tutorial provides a step-by-step guide to building a small federated

  server with the Fedify framework.  It is intended for developers who want

  to build a federated server with the Fedify framework.

prev:

  text: Installation

  link: ./install.md

---



In-depth tutorial

=================

Learning the basics of Fedify

=============================



In this tutorial, we will build a small federated server that can only accept

follow requests to understand the basic concepts of the Fedify framework.
@@ -743,7 +740,7 @@ on your Mastodon instance (or any other ActivityPub server you have account on). 
To look up the actor *me*, you need to search with the full handle of the actor

(i.e., *@me@your-server-domain*):



![Search results on Mastodon; the actor @me shows up.](./tutorial/search-result.png)

![Search results on Mastodon; the actor @me shows up.](./basics/search-result.png)



When you find the actor *me*, click on the actor's profile and then click on

the *Follow* button.  You should see your Mastodon account sending a follow