Merge github.com:5e-bits/docs

.github/workflows/deploy.yml

@@ -26,7 +26,7 @@ jobs:
       # Popular action to deploy to GitHub Pages:
       # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
       - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           # Build output to publish to the `gh-pages` branch:

.gitignore

@@ -222,4 +222,3 @@ $RECYCLE.BIN/
 *.lnk
 
 # End of https://www.toptal.com/developers/gitignore/api/node,windows,macos
-

README.md

@@ -1,6 +1,6 @@
 # Website
 
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
 
 ### Installation
 

babel.config.js

@@ -1,3 +1,3 @@
 module.exports = {
-  presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
 };

docs/faq.md

@@ -1,5 +1,11 @@
 # FAQ
 
+### A monster, spell, subclass, etc. is missing from the API / Database. Can I add it?
+
+Please check if the data is within [the SRD.](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf) If it is, feel free to open an issue or PR to add it yourself. Otherwise, due to legal reasons, we cannot add it.
+
+[This reddit post is a good explanation of how this works.](https://www.reddit.com/r/DnD/comments/hqw3jx/til_that_the_spell_tashas_hideous_laughter_was/fy0q5ej/)
+
 ### What is the SRD?
 
 The SRD, or Systems Reference Document, contains guidelines for publishing content under the OGL. This allows for some of the data for D&D 5e to be open source. The API only covers data that can be found in the SRD. [Here's a link to the full text of the SRD.](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf)
@@ -8,14 +14,35 @@ The SRD, or Systems Reference Document, contains guidelines for publishing conte
 
 The Open Game License (OGL) is a public copyright license by Wizards of the Coast that may be used by tabletop role-playing game developers to grant permission to modify, copy, and redistribute some of the content designed for their games, notably game mechanics. However, they must share-alike copies and derivative works. [More information about the OGL can be found here.](https://en.wikipedia.org/wiki/Open_Game_License)
 
-### A monster, spell, subclass, etc. is missing from the API / Database. Can I add it?
+### Can I support this project? Where can I contribute to this project?
+
+Yes! Please! This is a evolving API and having fresh ideas are always welcome! You can open an issue in either repo, open a PR for changes, or just discuss with other users in this discord.
 
-Please check if the data is within the SRD. If it is, feel free to open an issue or PR to add it yourself. Otherwise, due to legal reasons, we cannot add it.
+Additionally, there is a separate Docker image for each repo so you only have to run as much as you need.
+
+[The repo for the data lives here.](https://github.com/bagelbits/5e-database)
+[The repo for the API lives here.](https://github.com/bagelbits/5e-srd-api)
 
 ### Can this API be self hosted?
 
 Yes it can! You can also host the data yourself if you don't want to use the API at all. You can also make changes and add extra data if you like. However, it is up to you to merge in new changes to the data and API.
 
 ### Can I publish is on `<insert platform>`? Is this free use?
 
-Yes, you can. The API itself is under the [MIT license](https://opensource.org/licenses/MIT), and the underlying data accessible via the API is supported under the SRD and OGL.
+Yes, you can. The API itself is under the [MIT license](https://opensource.org/licenses/MIT), and the underlying data accessible via the API is supported under the SRD and OGL.
+
+### Is there a limit to the number of calls I can make at a time?
+
+Yes. Currently there is a limiter in place for 10k requests per second per IP. This is subject to change if something more practical needs to be enforced.
+
+### Am I allowed to/Is it legal to put more than just SRD content in my own version of this API? Is it legal for me to do `<insert questionable idea>`?
+
+¯\\\_(ツ)\_/¯ I am not a lawyer, so do this at your own risk. However, one of our users made a wonderful flow chart that can help point you in the right direction. I must stress the point that this is not legal advice though.
+
+![Copyrights Flowchart](/img/faq/copyrightsFlowchart.png)
+
+### How can I help fund this project?
+
+To be completely transparent, this project only costs me $7/mo to run. However, if you want to [help fund it anyways](https://ko-fi.com/bagelbits).
+
+You can also find links on both repos.

docs/graphql.md

@@ -20,4 +20,4 @@ query {
     }
   }
 }
-```
+```

docs/introduction.md

@@ -10,15 +10,15 @@ sidebar_position: 1
 
 ### :wave: Welcome
 
-Welcome to the D&D 5e SRD API, the Dungeons & Dragons 5th Edition API! 
+Welcome to the D&D 5e SRD API, the Dungeons & Dragons 5th Edition API!
 
-This documentation should help you familiarize yourself with the resources available and how to consume them with HTTP requests. Read through the [Tutorial](/docs/tutorials/) getting started section before you dive in. 
+This documentation should help you familiarize yourself with the resources available and how to consume them with HTTP requests. Read through the [Tutorial](/docs/tutorials/) getting started section before you dive in.
 
 Most of your problems should be solved just by reading through it.
 
 ### :lock: Authentication
 
-This is a completely open API. **No authentication is required to query and get data**. This also means that we've limited what you can do to just `GET`-ing the data. 
+This is a completely open API. **No authentication is required to query and get data**. This also means that we've limited what you can do to just `GET`-ing the data.
 
 If you find a mistake in the data, feel free to [message us](https://discord.gg/TQuYTv7)!
 

docs/reference/status-page.md

@@ -3,4 +3,3 @@
 The status page for the API can be found [here](https://5e-bits.github.io/dnd-uptime/).
 
 ![Status Page](/img/status-page.png)
-

docs/tutorials/advanced/monster-search-with-javascript.mdx

@@ -178,5 +178,4 @@ function searchMonster(monsterName) {
 
 ## Conclusion
 
-Congratulations! You've successfully built an interactive monster search web application using JavaScript, HTML, and CSS. Users can now search for D&D 5e monsters and view their details. 
-
+Congratulations! You've successfully built an interactive monster search web application using JavaScript, HTML, and CSS. Users can now search for D&D 5e monsters and view their details.

docs/tutorials/basic/discover-dnd-races-with-shell-scripting.mdx

@@ -3,8 +3,8 @@ import LearningObjectives from '@site/src/components/LearningObjectives';
 # Discover D&D Races with Shell Scripting
 
 <LearningObjectives objectives={[
-    "Learn to use cURL", 
-    "Learn to write a simple Bash script", 
+    "Learn to use cURL",
+    "Learn to write a simple Bash script",
     "Learn to make a script interactive"
 ]}/>
 
@@ -100,4 +100,3 @@ Enter the name of a D&D race: dwarf
 ## Celebrate Your Coding Victory!
 
 Congratulations, young adventurers! You've crafted your very own D&D Race Search Tool using Bash scripting. You can now explore different races and learn about their unique abilities, traits, and more. Your journey has just begun, and there's so much more to discover in the realm of coding and Dungeons & Dragons. May your code be bug-free and your rolls be critical hits! 🎉🏰🧝‍♂️
-

docs/tutorials/beginner/graphql.mdx

@@ -39,7 +39,7 @@ Let's start by getting a list of all the monsters in the database. To do this, w
 ```graphql
 query Monsters {
   monsters {
-    
+
   }
 }
 ```
@@ -59,7 +59,7 @@ query Monsters {
     name
     index
     armor_class {
-      
+
     }
   }
 }

docs/tutorials/index.mdx

@@ -24,4 +24,3 @@ Basic tutorials are designed to help you get started with the API. They are inte
 Advanced tutorials are designed to help you build more complex applications with the API. They are intended for developers who are comfortable with programming and want to build more advanced applications.
 
 <TutorialsList category="advanced" />
-