Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ Meteor 3 ] - API Docs #12926

Merged
merged 171 commits into from Feb 29, 2024
Merged

[ Meteor 3 ] - API Docs #12926

merged 171 commits into from Feb 29, 2024

Conversation

Grubba27
Copy link
Contributor

@Grubba27 Grubba27 commented Dec 21, 2023

This is the new docs that we said that we are working on.

This includes the revision of our API docs and a site for guiding current meteor users to the 3.0 version.

For a preview you can check here

Checklist:

  • Toubleshooting
  • Command Line
  • About Meteor
  • Changelog
  • Roadmap
  • API
  • Packages
  • Work on the redirects(only one missing is API Map page)
  • Make sure that there are no dead links

API:

  • Email
  • API - Core
  • API - Pub and Sub
  • Check
  • Server Connections
  • Collections
  • Session
  • Accounts
  • Passwords
  • Accounts ( Multi-server)
  • Assets
  • Timers
  • Blaze / Templates
  • Reactive Var + Reactive Dict
  • EJSON
  • Package.js
  • Mobile Configuration

Packages:

  • Accounts-ui
  • accounts-passwordless
  • accounts-2fa
  • appcache
  • audit-arguments-checks
  • autoupdate
  • browser-polic
  • bundler-visulizer
  • coffescript
  • ecmascript
  • fetch
  • hot-module-replacement(HMR)
  • less
  • logging
  • markdown
  • modules
  • oauth-encryption
  • random
  • server-render
  • standard-minifier-css
  • underscore
  • url
  • webapp
  • Package-Listing

Pages that need to be updated:

  • WebApp

    Some methods are now async

    Changed engine from connect to express and changed API naming to match express. It needs to be documented as well.

  • server-render

    getBoilerplate is now async

  • ordered-dict

    Added forEachAsync method

  • oauth

    Private methods are now async. This might affect end user

    1 - OAuth._storeRequestToken and OAuth._retrieveRequestToken are async(maybe we need to review docs on how to use oauth1

    2 OAuth._requestHandlers['2']` is now async

  • MongoDB

  • Minimongo

    cursor.observe now returns isReady and isReadyPromise wich indicates if the cursor is ready and if the callbacks are have been called

    If you only use it in the Client or as a LocalCollection things have not changed

  • Minifiers

    Minifiers are now async,

  • HTTP

  • Email

Email.send is no longer available. Use `Email.sendAsync` instead. needs to be updated in the docs as well

Updated types to reflext async methods and `Email.send` depracation.

Maybe we should be able to use both but it needs to be explained that send and sendAsync are the same

@Grubba27
Copy link
Contributor Author

Grubba27 commented Feb 19, 2024

just a quick update, guys:
The API docs are nearly ready*. I’ve updated it from our changelog, where I found that it was misleading/wrong.
Also, I’ve all our links from the docs. Some of them were redirected to nothing.
*: The API map page has a few redirects that are not working, but this is the next thing I should be solving, and then we will have new docs
For those who want to test it, here is the link: https://v3-docs.meteor.com/

**: Forgot I need to setup algolia as well

@Grubba27 Grubba27 marked this pull request as ready for review February 26, 2024 15:48
@Grubba27 Grubba27 merged commit 273dea4 into release-3.0 Feb 29, 2024
4 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants