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

Remove and replace all references to Xenko in the documentation

Open Jklawreszuk opened this issue 2 years ago • 20 comments

The mention of Xenko may be confusing for new users and should be replaced with the current engine name. I'm creating this issue for tracking 😃

  • [x] https://doc.stride3d.net/latest/en/manual/get-started/install-stride.html
  • [x] https://doc.stride3d.net/latest/en/manual/troubleshooting/stride-doesnt-run.html
  • [ ] https://doc.stride3d.net/latest/en/manual/stride-launcher/index.html
  • [ ] https://doc.stride3d.net/latest/en/manual/get-started/index.html
  • [ ] https://doc.stride3d.net/latest/en/manual/get-started/visual-studio-extension.html
  • [ ] https://doc.stride3d.net/latest/en/manual/get-started/launch-stride.html
  • [ ] https://doc.stride3d.net/latest/en/manual/get-started/create-a-project.html

Vaclav: There is lots of Xenko. The easy solution is just to replace the images with the current ones. Please make them .webp.

Jklawreszuk avatar Dec 12 '23 11:12 Jklawreszuk

@VaclavElias I can work on this issue. Can you tell what to replace Xenko with?

ElvinPero avatar Jan 04 '24 16:01 ElvinPero

Hi @ElvinPero. Thank you. I believe, @Jklawreszuk is referring to these 2 pages at least? Am I right?

There is lots of Xenko. The easy solution is just to replace the images with the current ones. Please make them .webp.

More time conusiming would be to actually to review the processes and add any missing text content and screenshots but that can be actually a separate issue.

https://doc.stride3d.net/latest/en/manual/get-started/install-stride.html https://doc.stride3d.net/latest/en/manual/stride-launcher/index.html

Do you want me to assing this issue to you?

VaclavElias avatar Jan 04 '24 17:01 VaclavElias

@VaclavElias Kindly assign this to me and thanks for the explanation.

ElvinPero avatar Jan 04 '24 17:01 ElvinPero

We found other 4 pages with the old Xenko screenshots..

https://doc.stride3d.net/latest/en/manual/get-started/index.html https://doc.stride3d.net/latest/en/manual/get-started/visual-studio-extension.html https://doc.stride3d.net/latest/en/manual/get-started/launch-stride.html https://doc.stride3d.net/latest/en/manual/get-started/create-a-project.html

VaclavElias avatar Jan 04 '24 18:01 VaclavElias

I upadated the original description with a Task list.

VaclavElias avatar Jan 04 '24 18:01 VaclavElias

@VaclavElias I installed and followed steps in the old documentation but some things are removed like agreement policy in the installer no longer shows during installation. Should I remove the steps that are no longer needed in the recent version? Also can I make PR for the first 2 pages first and handle next 4 in a separate PR?

ElvinPero avatar Jan 05 '24 11:01 ElvinPero

Yes, please, you can remove the steps that are no longer needed. We can always update the docs if something is missed.

Regarding the PRs, your call in this case, because these are safe updates so it doesn't matter if it is just one PR or multiple, whatever works for you 😁.

Thank you.

VaclavElias avatar Jan 05 '24 12:01 VaclavElias

Hi @ElvinPero, do you have any update for us?

VaclavElias avatar Feb 07 '24 22:02 VaclavElias

Hello @VaclavElias sorry for the delayed response, due to external workload I was not able to work on the issue. Kindly assign it to someone else.

ElvinPero avatar Feb 08 '24 05:02 ElvinPero

If this isn't an urgent task, I could take this on over the next two-ish weeks while I'm waiting for feedback to come in for the blog post.

parhamgholami avatar Feb 08 '24 08:02 parhamgholami

No problem @ElvinPero, circumstanes are changing for all of us. I made new screenshots like a year ago for this issue and didn't come back to it 🤣. I am reassigning this to @parhamgholami. Thanks @parhamgholami.

I have updated the issue with the pages we are aware need new screenshots, maybe updated/improved content if needed optionally.

Also something related, which can be sorted after. I will create Issue for this in Stride repo as it needs to be fixed there https://github.com/stride3d/stride/issues/660 https://discord.com/channels/500285081265635328/727168636770582581/1150170088637468846 https://discord.com/channels/500285081265635328/740163288746426368/1010985661702078484

VaclavElias avatar Feb 08 '24 09:02 VaclavElias

Sounds good! I'll post updates when I get started. 😄

parhamgholami avatar Feb 08 '24 09:02 parhamgholami

@parhamgholami I can take the first one (https://doc.stride3d.net/latest/en/manual/get-started/install-stride.html), if you like. I already started collecting the screenshots.

Kryptos-FR avatar Feb 11 '24 13:02 Kryptos-FR

@parhamgholami I can take the first one (https://doc.stride3d.net/latest/en/manual/get-started/install-stride.html), if you like. I already started collecting the screenshots.

Sounds good!

parhamgholami avatar Feb 11 '24 18:02 parhamgholami

I have ticked the first box so install-stride.md is done.

VaclavElias avatar Feb 11 '24 23:02 VaclavElias

Adding https://doc.stride3d.net/latest/en/manual/troubleshooting/stride-doesnt-run.html to the list, since it is referenced by the Getting Started page.

Kryptos-FR avatar Feb 12 '24 08:02 Kryptos-FR

Just wanted to give an update: I haven't started on this yet. Now that I finished the blog post, I'll be focusing on this next. Should be starting as soon as tomorrow or Sunday.

parhamgholami avatar Mar 16 '24 06:03 parhamgholami

Can i be assign?

I have already update some screenshots on the Get started!

However, i din't update yet screenshots in the Assets and Scenes tabs!

https://github.com/user-attachments/assets/d24e8c13-426d-4e18-b67c-f1f0d6406eb9

minktusk avatar Aug 24 '24 04:08 minktusk

@parhamgholami, I will be assigning also @minktusk. I hope it is ok :)

VaclavElias avatar Aug 24 '24 16:08 VaclavElias

@minktusk, yes please.

VaclavElias avatar Aug 24 '24 16:08 VaclavElias

@minktusk, do you have any update for us? 🙂

VaclavElias avatar Sep 29 '24 23:09 VaclavElias