Merge pull request #36 from WaifuAPI/staging

a3ryk · web-flow · commit be2733054047 · 2023-07-05T12:08:39.000+05:30
Staging
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at notaeryk@gmail.com or on [Discord](https://discord.gg/yyW389c). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,26 @@
+# Contributing to Waifu.it
+
+We love your input! We want to make contributing to this project as easy as possible, whether it's:
+
+- Submitting a fix
+- Reporting an issue
+- Becoming a maintainer
+- Proposing new features
+- Discussing the current state of the code
+
+## Code of Conduct
+
+The code of conduct is described in [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Feature Request
+
+Great Feature Requests tend to have:
+
+- A quick idea summary.
+- What & why you wanted to add the specific feature.
+- Additional context like images, links to resources to implement the feature etc, etc.
+
+## License
+
+By contributing to Animu Documentation, you agree that your contributions will be licensed
+under the [LICENSE file](LICENSE.md).
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Waifu.it
+Copyright (c) 2023 Waifu.it
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -1,23 +1,60 @@
-# Nextra Docs Template 
+# Waifu.it Documentation
 
-This is a template for creating documentation with [Nextra](https://nextra.site).
+## Getting Started
 
-[**Live Demo →**](https://nextra-docs-template.vercel.app)
+Install dependencies,
 
-[![](.github/screenshot.png)](https://nextra-docs-template.vercel.app)
+```bash
+$ npm i
+```
 
-## Quick Start
+Start the dev server,
 
-Click the button to clone this repository and deploy it on Vercel:
+```bash
+$ npm run dev
+```
 
-[![](https://vercel.com/button)](https://vercel.com/new/clone?s=https%3A%2F%2Fgithub.com%2Fshuding%2Fnextra-docs-template&showOptionalTeamCreation=false)
+Build documentation,
 
-## Local Development
+```bash
+$ npm run build
+```
 
-First, run `pnpm i` to install the dependencies.
+# Contributing
 
-Then, run `pnpm dev` to start the development server and visit localhost:3000.
+All contributions are greatly appreciated, but I recommend creating an issue or replying in a comment to let me know what you are working on first that way we don't overwrite each other.
 
-## License
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on this project.
+
+## Issues
+
+- Feature requests/enhancements
+- Bug reports
+- Questions/feedback
+
+## Branches
+
+- production -> don't touch, this is what's running in production
+
+- staging -> [pull request][pr] this branch for everything
+
+## Pull Requests
+
+All pull requests are welcome!
+
+- [Fork][fork] the repository on GitHub.
+
+- [Clone][cloning] the forked repo to your local machine.
+
+- Do you changes
+
+- Commit your changes
+
+- Push your changes back up to your fork.
+
+- When you're ready, submit a [pull request][pr] so that we can review your changes.
+
+[fork]: https://help.github.com/en/articles/fork-a-repo
+[cloning]: https://help.github.com/en/articles/cloning-a-repository
+[pr]: https://help.github.com/en/articles/about-pull-requests
 
-This project is licensed under the MIT License.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "docs.waifu.it",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "The new and improved documentation for Waifu.it",
   "scripts": {
     "dev": "next dev",
@@ -17,14 +17,14 @@
   },
   "homepage": "https://github.com/WaifuAPI/Documentation/#readme",
   "dependencies": {
-    "next": "^13.0.6",
+    "next": "^13.4.8",
     "nextra": "2.0.1",
     "nextra-theme-docs": "2.0.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "devDependencies": {
     "@types/node": "18.11.10",
-    "typescript": "^4.9.3"
+    "typescript": "^4.9.5"
   }
 }
diff --git a/pages/rest-api/Texts/Owoify/_meta.json b/pages/rest-api/Texts/Owoify/_meta.json
@@ -0,0 +1,3 @@
+{
+  "generate": "Generate"
+}
diff --git a/pages/rest-api/Texts/Owoify/generate.mdx b/pages/rest-api/Texts/Owoify/generate.mdx
diff --git a/pages/rest-api/Texts/_meta.json b/pages/rest-api/Texts/_meta.json
@@ -14,5 +14,9 @@
   "Tags": {
     "title": "Tags",
     "theme": { "collapsed": true }
+  },
+  "Owoify": {
+    "title": "Owoify",
+    "theme": { "collapsed": true }
   }
 }
diff --git a/theme.config.tsx b/theme.config.tsx
@@ -8,7 +8,7 @@ const config: DocsThemeConfig = {
   },
   faviconGlyph: "🚧",
   banner: {
-    text: "🚧 Documentation is undergoing reconstruction 🚧",
+    text: "🚧 Undergoing reconstruction 🚧",
   },
   logo: <span>Documentation</span>,
   navbar: {
@@ -59,10 +59,11 @@ const config: DocsThemeConfig = {
   },
   head: function useHead() {
     const description =
-      "A collection of documentation for each provider available on Waifu.it. Find out how to efficiently use the Waifu.it API here!";
+      "A collection of documentation for each endpoints available on Waifu.it. Find out how to efficiently use the Waifu.it API here!";
     return (
       <>
         <meta httpEquiv="Content-Language" content="en" />
+        <meta name="keywords" content="anime, waifu, anime facts, anime quotes, waifu api, waifu pictures, anime api, opensource api" />
         <meta name="description" content={description} />
         <meta name="og:description" content={description} />
       </>
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "generate": "Generate"`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -14,5 +14,9 @@`
`14`	`14`	`"Tags": {`
`15`	`15`	`"title": "Tags",`
`16`	`16`	`"theme": { "collapsed": true }`
	`17`	`+ },`
	`18`	`+ "Owoify": {`
	`19`	`+ "title": "Owoify",`
	`20`	`+ "theme": { "collapsed": true }`
`17`	`21`	`}`
`18`	`22`	`}`