Skip to content

Commit

Permalink
docs: remove references to old documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
favna committed Oct 30, 2021
1 parent c5b62c4 commit 8dcf4d5
Show file tree
Hide file tree
Showing 7 changed files with 3 additions and 273 deletions.
28 changes: 2 additions & 26 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,6 @@
4. Commit your changes, and push them.
5. Submit a Pull Request [here]!

## Contributing to the guides

All guides for the Sapphire Community use Markdown formatting.

When writing guides there are some rules to follow:

1. All files should have the `.md` file extension.
2. Folder names are allowed to have spaces.
3. All folder names should be in lower case and different words should be split by hyphens (e.g., `hello-world` or `getting-started`).
4. File names should _never_ have spaces.
5. File names that consist of multiple words should be PascalCased.
6. Information in a guide page should be generally useful to the majority of people.
- The single exception to this goes to guides in the "Advanced" folder, which can cover any kind of advanced or complex usage topic.
7. There are several variables that will be replaced when parsing the `.md` file for the documentation website. Variables are denoted by the pattern `{@variableName (parameter)}`. The supported variables are:
- `{@branch}` - for the current branch name.
- `{@link <TSDoc symbol name>}` - wherein `<TSDoc symbol name>` is a reference to some TypeScript interface / class / function etc parsed from TSDoc. This will link the API page of that symbol.
- `{@typedef <TSDoc interface/type/class name>}` - wherein `<TSDoc interface/type/class name>` is the name of a TypeScript interface, class or type. This will inline all the properties of that interface/type/class as a table, with links back to their API documentation page.
- `{@guide <Guide file name>}` - wherein `<Guide file name>` is the name of another guide file in this same project _without file extension_. For example linking to `CreatingArguments.md` would be `{@guide CreatingArguments}`.

## Contributing to the code

**The issue tracker is only for issue reporting or proposals/suggestions. If you have a question, you can find us in our [Discord Server][discord server]**.
Expand All @@ -45,18 +26,13 @@ There are a number of guidelines considered when reviewing Pull Requests to be m
- Everything should be shard compliant. If code you put in a pull request would break when sharding, break other things from supporting sharding, or is incompatible with sharding; then you will need to think of a way to make it work with sharding in mind before the pull request will be accepted and merged.
- Everything should follow [OOP paradigms][oop paradigms] and generally rely on behaviour over state where possible. This generally helps methods be predictable, keeps the codebase simple and understandable, reduces code duplication through abstraction, and leads to efficiency and therefore scalability.
- Everything should follow our ESLint rules as closely as possible, and should pass lint tests even if you must disable a rule for a single line.
- Scripts that are to be ran outside of the scope of the bot should be added to [scripts] directory and should be in the `.mjs` file format.

<!-- Link Dump -->

<!-- Guides -->

<!-- Code -->

[discord server]: https://sapphirejs.dev/discord
[here]: https://github.com/sapphiredev/framework/pulls
[here]: https://github.com/sapphiredev/cli/pulls
[eslint]: https://eslint.org/
[node.js]: https://nodejs.org/en/download/
[yarn]: https://classic.yarnpkg.com/en/docs/install
[yarn]: https://yarnpkg.com/getting-started/install
[oop paradigms]: https://en.wikipedia.org/wiki/Object-oriented_programming
[scripts]: /scripts
54 changes: 0 additions & 54 deletions .github/workflows/continuous-delivery.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,57 +57,3 @@ jobs:
npm publish --tag ${TAG} || true
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

Docgen:
name: Docgen
runs-on: ubuntu-latest
if: "github.event_name == 'push'"
steps:
- name: Checkout Project
uses: actions/checkout@1e204e9a9253d643386038d443f96446fa156a97 # renovate: tag=v2
- name: Use Node.js v16
uses: actions/setup-node@270253e841af726300e85d718a5f606959b2903c # renovate: tag=v2
with:
node-version: 16
- name: Restore CI Cache
uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # renovate: tag=v2.1.6
id: cache-restore
with:
path: node_modules
key: ${{ runner.os }}-16-${{ hashFiles('**/yarn.lock') }}
- name: Install Dependencies if Cache Miss
if: ${{ !steps.cache-restore.outputs.cache-hit }}
run: yarn --immutable
- name: Build documentation
run: yarn docs
- name: Publish Docs
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
run: |
REPO="https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
echo -e "\n# Checkout the repo in the target branch"
TARGET_BRANCH="gh-pages"
git clone $REPO out -b $TARGET_BRANCH
echo -e "\n# Remove any old files in the out folder"
rm -rfv out/assets/*
rm -rfv out/interfaces/*
rm -rfv out/*.html
echo -e "\n# Move the generated docs to the newly-checked-out repo, to be committed and pushed"
rsync -vaI .all-contributorsrc out/
rsync -vaI LICENSE.md out/
rsync -vaI README.md out/
rsync -vaI docs/ out/
echo -e "\n# Commit and push"
cd out
git add --all .
git config user.name "${GITHUB_ACTOR}"
git config user.email "${GITHUB_EMAIL}"
git commit -m "docs: api docs build for ${GITHUB_SHA}" || true
git push origin $TARGET_BRANCH
env:
GITHUB_TOKEN: ${{ secrets.SKYRA_TOKEN }}
GITHUB_ACTOR: NM-EEA-Y
GITHUB_EMAIL: contact@skyra.pw
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,6 @@ npm install @sapphire/framework discord.js

---

## API Documentation

For the full API documentation please refer to the TypeDoc generated [documentation](https://sapphiredev.github.io/framework).

## Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!
Expand Down
70 changes: 0 additions & 70 deletions guides/getting-started/CreatingCommands.md

This file was deleted.

43 changes: 0 additions & 43 deletions guides/getting-started/CreatingListeners.md

This file was deleted.

75 changes: 0 additions & 75 deletions guides/getting-started/GettingStarted.md

This file was deleted.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
"bugs": {
"url": "https://github.com/sapphiredev/framework/issues"
},
"homepage": "https://sapphiredev.github.io/framework",
"homepage": "https://www.sapphirejs.dev",
"commitlint": {
"extends": [
"@commitlint/config-conventional"
Expand Down

0 comments on commit 8dcf4d5

Please sign in to comment.