Skip to content

[Docs Tracking] Docs todo #513

Description

@Buckminsterfullerene02

Will update as I think of things that need to be done.

  • Settle officially on a versioning system, like semver
  • Once we have an official versioning system, explain ABI, and which version number changes are expected to break it and thus require mods to be rebuilt, and that mod creators should develop mods based on the latest non-breaking version.
  • Explain difference of xmake f -m and xmake/xmake build. Some users have been confused that the former command "doesn't work" because they aren't aware it is only for setting configuration
  • Fill out contributing page (and maybe include in repo root as well). This should include; how to make changelog entries, how PR and release system works, using clang format, how to update docs, etc.
  • Update build instructions with -y on commands because minor QoL
  • Explain how C++ devs can use xmake.lua to; setup cmake projects, include headers libs, include SDKs, link dlls, etc. Provide examples. If we expect developers to learn a new build system we should make it as easy as possible for them by providing our own docs rather than relying on xmake docs and having to figure out how to apply it to ue4ss

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions