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

Documentation improvements #3

Open
zgotsch opened this issue Nov 16, 2021 · 0 comments
Open

Documentation improvements #3

zgotsch opened this issue Nov 16, 2021 · 0 comments

Comments

@zgotsch
Copy link

zgotsch commented Nov 16, 2021

The documentation is seems like it's mostly copied from the Content Record Library (Content Record DAC). This is confusing because it says things like "The main purpose of this tool is content discovery; if all skapps were to make use of this library, the end result would be a scrapable global record of all content and the popularity of that content and the skapp."

Additionally, it ends in the middle of a sentence ("This is when a user"):
image

The example code

import { SkynetClient } from "skynet-js";
import { UserProfileDAC } from "@skynethub/userprofile-library";

(async () => {
  // create client
  const client = new SkynetClient();

  // create content record
  const userProfileRecord = new UserProfileDAC();

  // load mysky
  const mySky = await client.loadMySky("exampleskapp.hns");
  
  // get userID
  const userID = await mySky.userID()
  
  // load DACs
  await mySky.loadDacs(userProfileRecord);

  let userProfile =await mySky.getProfile(userID);
  let userPreference =await mySky.getPreferences(userID);



 
})();

is poorly formatted and incorrect. loadProfile (and getPreferences) is not a method on mySky, but on IUserProfileDAC (userProfileRecord in the example).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant