Comments (3)
Personally I'd like to keep the Ore API v2 docs in one place, not two (although docs is welcome to parse the swagger.json file and generate it from that).
I think a link to the new docs with a notice that the old docs are being deprecated would be enough. I also want to hold off on officially recommending API v2 over v1 for serious work until Ore 2.0.0 has been released.
Something else we might think of is to have some sort of Ore API v2 by example, or more detailed cos here.
from spongedocs.
Keeping it in SpongeDocs means we can do minor edits more easily. It's not third-party content, so it does belong in there. We have six pages of Ore docs, some won't have to change much. We could reformat the remaining ones to more closely match the doc on Ore. Any opinions?
from spongedocs.
We can just deprecate our old API pages and link to the new Swagger pages for Ore API if you prefer. Whenever it's ready to launch.
from spongedocs.
Related Issues (20)
- A spelling mistake in ZHCN page of plugin/configuration/index . HOT 2
- Add documentation about messaging channels
- Add language tabs on code blocks HOT 2
- Track Enhancements of Debugging Documentation HOT 3
- Documenting system properties HOT 4
- Windows shell issue resolved, should be documented HOT 4
- Debugging tutorial is overcomplicated HOT 6
- Plundering the SpongeCommon Wiki HOT 2
- Active Page on PaginationService HOT 1
- Fix Ray Tracing documentation HOT 5
- Outdated information on Ore Publishing Guide
- Add documentation for "Incompatible" mods HOT 11
- Recommend a specific version of gradle
- Mixins Fail to apply, causing client to crash upon joining a world
- ContextCalculator docs state it must be thread safe, but use a potentially unsafe example HOT 3
- [API-8] Docs Update Tracker HOT 2
- References to outdated maven repo
- Gradle page needs updating
- Dependency Dashboard
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from spongedocs.