-
-
Notifications
You must be signed in to change notification settings - Fork 112
Open
Labels
help wantedWe would appreciate contributionsWe would appreciate contributionshigh priorityThis needs to be fixed ASAPThis needs to be fixed ASAPinput wantedWe would like to hear your opinionWe would like to hear your opinionoutdated docsThe API has changed and the docs are outdatedThe API has changed and the docs are outdatedtodoA reminder to do thingsA reminder to do things
Milestone
Description
We plan to update the existing API 7 docs to API 8.
This is a complete tree of the existing docs, all unchecked pages needs to be checked whether they need to be updated and be updated or replaced.
Feel free to add a comment regarding API features that have been added and are not documented at all yet.
If you wish to be in charge of the update for a particular page or section, please comment. We appreciate any help.
All PRs regarding the api-8 docs should target the https://github.com/SpongePowered/SpongeDocs/tree/api-8 branch.
- index.rst
- about
- assets.rst
- faq.rst
- future.rst
- glossary.rst
- history.rst
- index.rst
- introduction.rst
- license.rst
- posting.rst
- privacy.rst
- rules.rst
- staff.rst
- structure.rst
- tos.rst
- contributing
- guidelines.rst
- howtogit.rst
- implementation
- codestyle.rst (WIP)
- datamanipulator.rst
⚠️ 🔥 - debugging
- faq.rst
- git.rst
- ide.rst
- index.rst
- issues.rst 👻 Fill "Debugging Sponge from IDE" page #356
- mixin.rst
- more.rst
- testing.rst
- tools.rst 👻 Fill "Debugging Sponge from IDE" page #356
- git-implementation.rst
- index.rst
- mixins.rst
- pr.rst
- index.rst
- porting.rst
- spongedocs.rst
- versioning.rst
- ore
- api.rst
- guidelines.rst
- index.rst
- publish.rst
- routes
- deploy-version.rst
- download.rst
- list-projects.rst
- list-users.rst
- list-versions.rst
- project-version.rst
- project.rst
- user.rst
- security.rst
- plugin
- api-versions.rst
- assets.rst
⚠️ - bans.rst
- blocks
- accessing.rst
- concepts.rst
- index.rst
- modifying.rst
- tileentities.rst
- virtualblock.rst
- bookview.rst
⚠️ - buildsystem.rst
- commands
- arguments.rst
- childcommands.rst
- commandcallable.rst
- creating.rst
- flags.rst
⚠️ - index.rst
- configuration
⚠️ - index.rst
⚠️ - loaders.rst
⚠️ - nodes.rst
⚠️ - serialization.rst
⚠️
- index.rst
- data
- customdatamanipulators.rst
- index.rst
- keys.rst
- serialization.rst
- transactions.rst
- database.rst
⚠️ - debugging.rst
- economy
- basics.rst
- implementing.rst
- index.rst
- practices.rst
- using.rst
- effects.rst
⚠️ - entities
- ai.rst
⚠️ - custom-ai.rst
⚠️ - index.rst
- modifying.rst
⚠️ - spawning.rst
- ai.rst
- event
- causes.rst
- custom.rst
- filters.rst
- index.rst
- listeners.rst
- game-profile-manager.rst
⚠️ - index.rst
- injection.rst
⚠️ - internals
- access-transformers.rst
- implementation.rst
- index.rst
- mcp-setup.rst
- mcp.rst
- mixins.rst
- items
- creating.rst
⚠️ - index.rst
- usage.rst
⚠️
- creating.rst
- lifecycle.rst
- logging.rst
- manager.rst
- metrics.rst
⚠️ - offline-userplayer-data.rst
- optional
- basic.rst
- index.rst
- usage.rst
- permissions.rst
⚠️ - placeholders
- creatingtokens.rst
⚠️ - index.rst
⚠️ - retrievingtext.rst
⚠️
- creatingtokens.rst
- plugin-class.rst
- plugin-identifier.rst
- plugin-meta.rst
- practices
- bad.rst
- best.rst
- index.rst
- project
- gradle.rst
- index.rst
- maven.rst
- version-numbers.rst
- ray-tracing.rst
⚠️ - scheduler.rst
⚠️ - services.rst
- tab-lists.rst
⚠️ - text
- index.rst
- messagechannels.rst 👻
- pagination.rst
- representations
- configurate.rst 👻
- formatting-code-legacy.rst 👻
- plain 👻
- index.rst
- json.rst 👻
- templates.rst 👻
- text.rst
- trade-offers.rst
⚠️ - tutorials.rst
- wgen
- customwgen.rst
⚠️ - index.rst
⚠️ - modifiers.rst
⚠️
- customwgen.rst
- workspace
- eclipse.rst
- idea.rst
- index.rst
- preparing
- git.rst
- ide.rst
- index.rst
- jdk.rst
- text.rst
- server
- getting-started
- bungeecord.rst
- configuration
- hocon.rst
- index.rst
- sponge-conf.rst
- implementations
- index.rst
- spongeforge.rst
- spongevanilla.rst
- index.rst
- jre.rst
- launch-script.rst
- migrating.rst
- port-forward.rst
- index.rst
- management
- bans.rst
- exploit-patches.rst
- index.rst
- performance-tweaks.rst
- permissions.rst
- plugins.rst
- whitelist.rst
- quickstart.rst
- spongineer
- bugreport.rst
- commands.rst
- debugging.rst
- incompatible.rst
- index.rst
- logs.rst
- properties.rst
- troubleshooting.rst
- getting-started
- versions
- filenames.rst
- index.rst
- legacy-versions.rst
- versioning.rst
🔥 = Might need a rewrite
👻 = This page is empty/awaiting content
Update-Tasks:
- Check all pages
- Fix imports/class/method references (Initial scan completed)
- Fix code examples
- Rewrite broken pages
- Check the docs for errors
- Goto 4
Metadata
Metadata
Assignees
Labels
help wantedWe would appreciate contributionsWe would appreciate contributionshigh priorityThis needs to be fixed ASAPThis needs to be fixed ASAPinput wantedWe would like to hear your opinionWe would like to hear your opinionoutdated docsThe API has changed and the docs are outdatedThe API has changed and the docs are outdatedtodoA reminder to do thingsA reminder to do things