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

Versioning for Content Creators section #71

Open
nearnshaw opened this issue Dec 29, 2022 · 1 comment
Open

Versioning for Content Creators section #71

nearnshaw opened this issue Dec 29, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@nearnshaw
Copy link
Member

Add a version selection dropdown for the entire Content creators section.
This will help navigate between the SDK6 and the SDK7 docs. Eventually, as we release more versions with breaking changes or new features, we can also host these as selectable versions in the dropdown.

Considerations and things to research:

  • In the future we plan on versioning SDK + Editor + CLI as a bundle with a single version number. That should make this task simpler.
  • Can we version only part of the content in the section, and avoid replicating documents that aren't affected by changes? Maybe only what's under the /sdk section, or even only specific pages with changes. That way the content is easier to maintain and better for SEO. This is especially relevant for topics inside "Content creators" that are not tied to the SDK version, like 3D modeling. In case we need to duplicate the content on each version, we'll only actively maintain the newer version.
  • When running search, users should only be searching within the version they're currently selecting
  • SEO: does it makes sense to unindex older versions? or somehow give more priority to the new ones always
  • We should display some kind of note on older versions, warning that the version you're looking at is not the latest, with a link to the latest
@nearnshaw nearnshaw added the documentation Improvements or additions to documentation label Dec 29, 2022
@nearnshaw nearnshaw added this to SDK Dec 29, 2022
@MetaverseUnknower
Copy link
Contributor

On a somewhat related note, the documentation for creating an SDK7 library seems to have been carried over from similar instructions in SDK6 - https://docs.decentraland.org/creator/development-guide/sdk7/create-libraries/

Unlike the original dcl init CLI command, npx @dcl/sdk-commands init does not present any options for what type of project to create, and running it just creates a cube spawner project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: No status
Development

No branches or pull requests

2 participants