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

Increase visibility to the Symbol Technical Reference Guide #838

Open
orisdorch opened this issue Jul 6, 2022 · 0 comments
Open

Increase visibility to the Symbol Technical Reference Guide #838

orisdorch opened this issue Jul 6, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@orisdorch
Copy link
Contributor

orisdorch commented Jul 6, 2022

Request to prominently feature a link to the Technical Reference Guide on docs.symbol.dev site.

Proposed Technical Reference source URL: https://symbol.github.io/symbol-technicalref/main.pdf

It seems the existing documentation site only refers to the Technical Reference Document on a single nested page: https://docs.symbol.dev/server.html - considering the amount of information included in the Technical Reference, it seems sensible to feature it more prominently on the docs site.

I would recommend featuring it in the Technology section, separately introduced either before or after the list of Concept pages: https://docs.symbol.dev/concepts/overview.html [source file: https://github.com/symbol/symbol-docs/blob/main/source/concepts/overview.rst ].

Note -this may fall under the redesign (#527), though considering the relative simplicity of the change, it seemed to merit its own issue.

@orisdorch orisdorch added the enhancement New feature or request label Jul 6, 2022
orisdorch added a commit to orisdorch/symbol-docs that referenced this issue Jul 6, 2022
cryptoBeliever pushed a commit to orisdorch/symbol-docs that referenced this issue Apr 10, 2023
cryptoBeliever pushed a commit to orisdorch/symbol-docs that referenced this issue May 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant