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

Reorg of the table of contents #562

Draft
wants to merge 64 commits into
base: master
Choose a base branch
from
Draft

Conversation

suearkinunity
Copy link
Contributor

@suearkinunity suearkinunity commented Aug 28, 2024

Purpose of this PR

This PR:

  • Removes the Menu page
  • Reorders most other pages

It doesn't reflect the work done on the Actions Reference area in DOCATT-5849, where I also messed with that area and broke it down to chunks. PR 561, currently in draft, shows that. In this PR, I just removed all those pages so I don't have to deal with them in two PRs.

Links

Jira: DOCATT-6821

Comments to Reviewers

This isn't finalised - I didn't check links, landing pages etc. I wanted to agree on a TOC first.

Sue Arkin and others added 18 commits August 14, 2024 08:39
1. Edited the page
2. Update the action name on the landing page
I don't think we have bevel faces as a standalone tool anymore. I think it's bevel edges, with the face edit mode selected.
Updated
Updated Bridge Edges and clarified (I hope) what open edges mean.
Since you can now bevel faces from the same tool, I replaced the example
Replaced the example because this tool now does two things
Plus two small edits to other pages
Reorder the whole thing
@unity-cla-assistant
Copy link

unity-cla-assistant commented Aug 28, 2024

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 3 committers have signed the CLA.

✅ modrimkus-unity
❌ Sue Arkin
❌ suearkinunity


Sue Arkin seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@suearkinunity suearkinunity changed the title Reorg of the table of contents Draft: Reorg of the table of contents Aug 28, 2024
Sue Arkin added 8 commits August 28, 2024 10:50
Merged into one page.
My thinking was that a user won't know whether they need a loop or ring selection until they've read the docs. Therefore, those two options need to be directly compared.
Sue Arkin and others added 12 commits September 4, 2024 08:57
Not fixing the actual page yet, though.
Making it match Msater
But I have some questions
I was using a couple of wrong files.

Also, I'm killing the Tools vs Actions page. First of all, we can't keep calling them actions because Actions is a category of Actions, and we can't do that to our poor users. Second, this page duplicates information that's better presented in its own context, such as creating meshes and the so-called actions. The conceptual difference between tool and action is really not something users need to worry themselves with.
Got rid of the inset page, because it's just a way to use Extrude
Changing to match 5835's changes to the edit pages, which include merging the tips/common page.
Copy link
Contributor

@JonMUnity JonMUnity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TOC looks good to me. I don't have any issues with it.

@@ -0,0 +1,26 @@
# Materials, Shaders, Textures, and UVs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page still needs to be added to the TOC.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replaced by workflow-texture-mapping... not sure why I ended up with three files that have exactly the same content

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replaced by workflow-texture-mapping... not sure why I ended up with three files that have exactly the same content

@suearkinunity
Copy link
Contributor Author

Something here is very odd. I'm going to have to rebuild this locally and see what's what.

@suearkinunity
Copy link
Contributor Author

All TOC changes - including all the action ref changes - are now in this PR.
So this PR is not ready for review anymore; I need to test it locally and see that, for example, the TOC is still buildable.

@suearkinunity suearkinunity marked this pull request as draft October 14, 2024 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants