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

[DOC] SocialDB Primitives #2429

Open
11 tasks
gagdiez opened this issue Jan 14, 2025 · 0 comments
Open
11 tasks

[DOC] SocialDB Primitives #2429

gagdiez opened this issue Jan 14, 2025 · 0 comments

Comments

@gagdiez
Copy link
Collaborator

gagdiez commented Jan 14, 2025

Documentation Type

New Documentation

What needs documentation?

While the "BOS framework" is deprecated, the social features offered by SocialDB (profiles, posts, likes, etc) are still widely used by the ecosystem, so we need to bring them as its own primitive, separated from BOS Widgets

The simplest path would be to create a page dedicated to use cases of https://nearbuilders.github.io/near-social-js/

Acceptance Criteria

Create a page on Primitives that explains how to:

  • Add https://nearbuilders.github.io/near-social-js/ to a project
  • Profile
    • Get a user's profile
    • Set a user's profile
  • Posts
    • Get posts from a user
    • Set posts for a user
  • Indexer
    • Index actions
    • Retrieve indexed actions
    • Use the indexer to get notifications

Resources & References

Priority

🟠 P1 : Important Documentation Gap

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: NEW❗
Status: No status
Development

No branches or pull requests

1 participant