symbol-docs icon indicating copy to clipboard operation
symbol-docs copied to clipboard

Remove unstable references

Open dgarcia360 opened this issue 5 years ago • 3 comments

Now that the first stable version of most packages has been released (1.0), it might be possible to remove from the site previous autogenerated documentation. For example, for the REST Gateway, it might be enough to just keep the versions v1.0.0 from now on.

image

Some of the pages where autogenerated references are published are:

  • https://docs.symbolplatform.com/api.html#endpoints
  • https://docs.symbolplatform.com/cli.html
  • https://docs.symbolplatform.com/references/java-sdk.html
  • https://docs.symbolplatform.com/references/typescript-sdk.html

How to unlist partial versions

For every repo, access the gh-pages branch and delete the versions that should not appear on the documentation site.

On the next documentation build, the extension https://github.com/nemtech/symbol-docs/blob/main/source/_ext/ghreference.py will automatically regenerate the lists.

dgarcia360 avatar Mar 18 '21 12:03 dgarcia360

hey @dgarcia360 !

fboucquez avatar Mar 18 '21 13:03 fboucquez

@fboucquez 👋

dgarcia360 avatar Mar 18 '21 13:03 dgarcia360

Cool, thanks for being around! 👍

segfaultxavi avatar Mar 18 '21 14:03 segfaultxavi