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

Shorten the readme #69

Closed
kubaau opened this issue Feb 2, 2023 · 2 comments · Fixed by #76
Closed

Shorten the readme #69

kubaau opened this issue Feb 2, 2023 · 2 comments · Fixed by #76
Assignees
Labels
docs Needs documentation update enhancement New feature or request

Comments

@kubaau
Copy link
Contributor

kubaau commented Feb 2, 2023

The readme is very long and some of the information in it should land on GitHub pages or in a similar doc tool.

@kubaau kubaau added docs Needs documentation update enhancement New feature or request labels Feb 2, 2023
@dzeitman
Copy link

dzeitman commented Feb 2, 2023

Does the Unreal Plugin Packaging supports a similar feature of optional asset and doc delivery that we use with Unity?

  • We might also package and include getting started steps in a similar fashion.
  • Give each version of Unreal Engine seems to be unique, perhaps each targeted SDK follows suit?
  • Elsewhere, we've adopted using GitHub Pages to host SDK docs.
  • Perhaps this repo has the getting started guide in a docs folder and instance and that is served up with GitHub pages?
  • This slightly shifts the shared focus of presenting and maintaining SDK docs to the individual repo; with the intent that they would likely be more often updated and aligned and easy to access for the developer.

@jfan-dolby
Copy link
Collaborator

See branch doc-github-page for an implementation using docusaurus

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Needs documentation update enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants