diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d158b384..b0dda75e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,10 +2,10 @@ ## Links -- [About](ABOUT.md) +- [Installation](README.md#installation) +- [Task for new contributors](docs/new-contributor-task.md) - [Issues](https://github.com/animenotifier/notify.moe/projects/10) -- [Code Style](CODE_STYLE.md) -- [Code of Conduct](CODE_OF_CONDUCT.md) +- [Code Style](docs/code-style.md) ## Communication diff --git a/ABOUT.md b/docs/about.md similarity index 100% rename from ABOUT.md rename to docs/about.md diff --git a/CODE_OF_CONDUCT.md b/docs/code-of-conduct.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to docs/code-of-conduct.md diff --git a/CODE_STYLE.md b/docs/code-style.md similarity index 100% rename from CODE_STYLE.md rename to docs/code-style.md diff --git a/EDITING.md b/docs/editing.md similarity index 100% rename from EDITING.md rename to docs/editing.md diff --git a/docs/new-contributor-task.md b/docs/new-contributor-task.md new file mode 100644 index 00000000..3ce77e26 --- /dev/null +++ b/docs/new-contributor-task.md @@ -0,0 +1,63 @@ +# Task for new contributors + +This task assumes that you have [installed](https://github.com/animenotifier/notify.moe#installation) notify.moe already, started the server with the `run` tool and have the code open in Visual Studio Code. + +# Step 1: Create a new page + +Let's call it `foobar`. Create a new directory under `pages`, called `foobar`. Then create the following files inside it: + +* foobar.go (controller) + +```go +package foobar + +import ( + "github.com/aerogo/aero" +) + +// Get ... +func Get(ctx *aero.Context) string { + return ctx.HTML("Hey it's me, foobar!") +} +``` + +* foobar.pixy (template) + +```pixy +component FooBar + h1 Hi! +``` + + +* foobar.scarlet (styles) + +```scarlet +.foobar + // Will be used later! +``` + +`foobar.pixy` and `foobar.scarlet` are currently not used but we'll deal with that later. + +## Step 2: Route your page + +Your page needs to become available on the `/foobar` route. Let's add it to `pages/index.go`, inside `Configure`: + +```go +l.Page("/foobar", foobar.Get) +``` + +Your IDE should automatically insert the needed package import upon saving the file. + +## Step 3: Add sidebar button + +Inside `layout/sidebar/sidebar.pixy`, add a new button inside the `Sidebar` component: + +```pixy +SidebarButton("Foobar", "/foobar", "plus") +``` + +## Step 4: Confirm it's there! + +Navigate to `beta.notify.moe` and you should see the button to access your newly made page! Yay! + +Feel free to play around with the code now. You can utilize pixy components by using the `components` package inside your controller. \ No newline at end of file