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

docs(UnoCheck): Improve Structure to find Troubleshooting and configuration options easyer via Searchengine #316

Conversation

DevTKSS
Copy link
Contributor

@DevTKSS DevTKSS commented Dec 15, 2024

What is this PR about

Moved the sub Topics into seperate Pages, so the search engine on the docs homepage can list them and they are more visible in the directory for research purposes of users.
also added the common There are one or more proplems detected without uno-check is providing information about it, where we need to run -verbose to see what is its problem
Seperated also the configuration options for same reason, seems to get overseen in the past

[ ] Breaking Changes => no
[x] Closes issue #19015 on the main uno repository but has already been closed from creator, its answering additionally recent upcoming discussions to that problem:
Main Uno repo discussion #14395
Main Uno repo discussion #19079

Anything else?

could we link the Uno check trouble shooting from the main docs trouble shooting area, if the searching person is not first finding this nested area here? Thanks!

@DevTKSS
Copy link
Contributor Author

DevTKSS commented Dec 15, 2024

maybe we will need to update the toc.yml file also, please check this in addition, I have no idea how this file has to look like correctly and the docfx guide on contribution did not help because I did not find the discribed Uno.UI-tools.slnf mentioned here after installation of the docfx via dotnet

@jeromelaban jeromelaban changed the title docs(UnoCheck)Improve Structure to find Troubleshooting and configuration options easyer via Searchengine docs(UnoCheck): Improve Structure to find Troubleshooting and configuration options easyer via Searchengine Jan 7, 2025
@jeromelaban
Copy link
Member

@DevTKSS thanks for your contribution! I've made an additional change to update the TOC. Would you mind rewriting the history for this commit 252bdaf to be docs: split doc in multiple pages?? Thanks!

@DevTKSS
Copy link
Contributor Author

DevTKSS commented Jan 7, 2025

@jeromelaban I would do what asked for, but I really dont know what this means... How can I rewrite "the History"? Is that sync fork or something else? Sorry, might sound stupid to a profi...

@jeromelaban
Copy link
Member

See this doc, with the section named Commit/Pull Request Format.

@DevTKSS
Copy link
Contributor Author

DevTKSS commented Jan 7, 2025

@jeromelaban
I do know that page, but that is not telling (or I might missunderstand it?) how I should rename any commit. currently fighting with my converters branch, where github desktop and vs decided to do as they like and this engines are not seem to care about any format while this.
Intention was originally to pull the online repo down to just delet the left trailing spaces and be fine, but seems like this engine wanted to upload what has been corrected/commited in github web. thats blanc horror at the moment...
hopefully the "reverte Commit" did work and resetted that auto thing but seems like it has only added one more not caring about format... gpt is also not helping as the commands it telling are not even available on the menus

@jeromelaban
Copy link
Member

The commands from the docs are exactly what you need to do this, you need to clone the repo, checkout your branch, then execute the commands to change the text of the first commit. You'll find a lot of online documentation on how to make an interactive rebase with the reword command.

@DevTKSS
Copy link
Contributor Author

DevTKSS commented Jan 7, 2025

@jeromelaban sidenote: since I do see this right now, is it on purpose, the uno.check repo branch of yours is named main instead of master as it is told to cmd in the docs? Wondered why that command failed until I seen that nameing difference of that repo...

on the way of applying made changes...

@DevTKSS
Copy link
Contributor Author

DevTKSS commented Jan 7, 2025

did apply changes, but the "rewriting history"... I am reading the interactive rebase on git-scm, which needs to do multiple rebases as it seems to be... should I run the commit with the recent changes applyed first or after this? I dont know it that head rebase to come to that commit mentioned to reword will delete the applyed changes again.

@DevTKSS
Copy link
Contributor Author

DevTKSS commented Jan 7, 2025

it just didnt let me do anything before commiting and now the old wrong formated one seems to be gone with commit applyed. would you check if that is now as wanted?

@DevTKSS
Copy link
Contributor Author

DevTKSS commented Jan 7, 2025

runned the rename as you told, but to me there is no change visible, sorry if it has not worked... the commit of code changes at least should have been applyed

@jeromelaban jeromelaban force-pushed the docs(UnoCheck)ImproveStructureForTroubleShootingResearch branch from a274831 to 5d24a06 Compare January 8, 2025 12:56
@jeromelaban jeromelaban enabled auto-merge January 8, 2025 13:00
@jeromelaban jeromelaban merged commit 3978ae3 into unoplatform:main Jan 8, 2025
2 of 3 checks passed
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.

2 participants