commit 0f793bfca2de6e2b0aeae92990713d8fc101441f
parent 10d85420d9e755f1eaff666145343e4fe02dabd2
Author: iostpa <iostpa@iostpa.com>
Date: Tue, 28 Oct 2025 15:48:13 +0200
Add a quick start guide and do some nitpicks
Diffstat:
3 files changed, 59 insertions(+), 2 deletions(-)
diff --git a/src/guides/dbh.md b/src/guides/dbh.md
@@ -5,6 +5,10 @@ tags: guides
icon: /media/dbh.png
---
+!!!danger
+This hosting service has changed a lot in recent times, so this guide may not be up to date with the current system the hosting provider has.
+!!!
+
# Setting up DanBot Hosting with an is-a.dev subdomain
This guide will walk you through the process of setting up a DanBot Hosting website and pointing your is-a.dev subdomain to it.
diff --git a/src/index.md b/src/index.md
@@ -9,7 +9,7 @@ icon: home
Here you'll find detailed guides, the JSON file structure, and more. If you'd like to contribute to our documentation, visit [our documentation repository](https://github.com/is-a-dev/docs) on GitHub.
## How to Register
-You can read about the domains' JSON file structure [here](useful/domain-structure).
+For our Quick Start guide you can click [here](useful/quickstart) to read it. You can also read about the domains' JSON file structure [here](useful/domain-structure).
## Guides
- [GitHub Pages](guides/github-pages)
@@ -18,7 +18,7 @@ You can read about the domains' JSON file structure [here](useful/domain-structu
- [Codeberg Pages](guides/codeberg-pages)
- [Netlify](guides/netlify)
- [ImprovMX](guides/improvmx)
-- [Zoho Mail](guides/zoho-mail.md)
+- [Zoho Mail](guides/zoho-mail)
- [DanBot Hosting](guides/dbh)
- [Hashnode Blogs](guides/hashnode)
- [Railway](guides/railway)
diff --git a/src/useful/quickstart.md b/src/useful/quickstart.md
@@ -0,0 +1,52 @@
+---
+icon: rocket
+label: Quick Start
+route: /quickstart
+tags: useful
+---
+
+# Requirements before starting
+
+Before you start the process of making a is-a.dev domain, make sure you have the following:
+ 1. You have a website that is at least complete and not a incomplete website with either barely anything on it or has incomplete sections.
+ 2. Make sure the website is a personal website (like a portfolio or a blog that's software developer related) or a non-commercial project that's software developer related.
+ 3. Make sure the website isn't for commercial purposes, if we see that the website is for commercial purposes we have the right to close the pull request. You can read more of our Terms of Conditions [here](https://is-a.dev/terms).
+
+After you've made sure that you meet these requirements, we can continue with the process of making a is-a.dev domain.
+
+# Making the is-a.dev domain
+
+Now, to make the file in the first place before making a pull request, you have to fork [our repository](https://github.com/is-a-dev/register). You can click the link [here](https://github.com/is-a-dev/register/fork) to fork our repository.
+
+After you've forked our repository, you can start making the file for your domain. To make the file, enter your fork of our repository (which you should already be there), enter the `domains` directory, also known as a folder, and create the file from there.
+
+You may be wondering, "How should I name the file?". The filename should be the domain name you want in lowercase and then the JSON extension (.json) at the end of the filename, so basically it would be something like this: `subdomain.json`. (Replace `subdomain` with the name you want to register of course)
+
+After you've finished with the filename, you can start making the file format of the JSON file. Now depending on your hosting provider, we have guides for most hosting providers (like GitHub Pages, Cloudflare Pages and Vercel, just to name a few) accessible in our documentation, but for hosting providers that don't have a guide, you should pay attention to what records they provide. An example of a valid file format is the one listed below, though you can also check out the [Domain Structure](useful/domain-structure) section to see what records we support.
+
+```json
+{
+ "owner": {
+ "username": "your-github-username"
+ },
+ "records": {
+ "CNAME": "example.org"
+ }
+}
+```
+
+!!!
+You should replace the placeholder username with your own GitHub username and the placeholder records with the valid records your hosting provider gave while trying to connect the domain.
+!!!
+
+When you've made sure that you have the valid file format and the correct filename, you can now start making a pull request. If you aren't sure if the JSON format is valid, you can check with [jsonlint](https://jsonlint.com/).
+
+## Making the pull request
+
+Assuming you know how GitHub works, it should be easy for you to make a pull request to our repository. For those who don't know how to make one, you can check [this guide from GitHub's documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) on how to do it.
+
+Before you create the pull request, make sure that you've read the pull request template and have completed it with the right information so that it saves both your time and our (maintainers) time. When you've completed it, you can create the pull request and wait for the maintainers to review the pull request. Make sure to also check the pull request from time to time to see if there's any chances that need to be made.
+
+# What do I do now?
+
+When your pull request has been merged by a maintainer, you have to make sure that you've connected the domain with your website, or else it won't work. Go to your website's settings and add the domain from there to make sure you've added it. After you've connected the domain, you are good to go! Now you can enjoy your is-a.dev domain. If you have any questions then you can either make a GitHub issue on our main repository or [join our Discord server](https://discord.gg/is-a-dev-830872854677422150) and ask there. You can also read our [FAQ](useful/faq) since we should have most common questions there.
+\ No newline at end of file
