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

setOptions operation on "List of Operations" page links to "Accounts" page unhelpfully #299

Closed
1 of 2 tasks
ElliotFriend opened this issue Feb 8, 2024 · 0 comments · Fixed by #592
Closed
1 of 2 tasks
Assignees
Labels
bug Something isn't working

Comments

@ElliotFriend
Copy link
Contributor

ElliotFriend commented Feb 8, 2024

The description of the setOptions operation on the "List of Operations" page directs users to the Accounts section when describing both the setFlags and the clearFlags parameter.

The problem is the accounts section doesn't really describe the flags, as the list of operations page suggests. You can follow a trail of links to eventually get to the information you need, but it's a bit confusing and easy to get lost along the way. Here is where I think a typical user might go through this process.

I think we should:

  • Fix the 404 link on the glossary entry for "Flags." That's just a no-brainer. (accidentally solved in [Soroban Merge] Create a "Learn" section of the docs #354)
  • The List of Operations page promises For details about the flags, please refer to the Accounts section. and it feels like this is too long of a trail to get to the actual useful information a developer might be looking for. We should link directly from the setOptions operation to the relevant part of the "Asset Design Considerations" page and take out all the intermediate steps.
@ElliotFriend ElliotFriend added the bug Something isn't working label Feb 8, 2024
@ElliotFriend ElliotFriend self-assigned this Feb 8, 2024
ElliotFriend added a commit that referenced this issue May 28, 2024
added a note about using the account-level flags for asset issuers
so it makes more sense to direct them to the asset design page.

Refs: #299
ElliotFriend added a commit that referenced this issue May 28, 2024
added a note about using the account-level flags for asset issuers
so it makes more sense to direct them to the asset design page.

Closes #299
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: Done
2 participants
@ElliotFriend and others