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
improve guide docs #1559
base: main
Are you sure you want to change the base?
improve guide docs #1559
Conversation
@davidhutchens can you please take a look? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for fixing our English documentation to actually be in English!
Since several files actually contain English, could you please make them match? If you are working on Unix, diff is a great tool to check.
</p> | ||
<p> | ||
Pour l'exemple, nous allons tester le circuit ci-dessous. Ce circuit donne les résultats de cinq fonctions logiques à partir de deux entrées. Il comporte une erreur la porte NAND du bas devrait être une porte AND. | ||
For the example, we will test the circuit below. This circuit gives the results of five logic functions from two inputs. It has an error the bottom NAND gate should be an AND gate. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The last part is not a sentence. I suggest adding "because" to get: "It has an error because the bottom..."
That change should also be made in the other files that contain English.
In fact, all the files that contain English (including en) should be identical as far as I know (except for the line that specifies the Content-Language). Currently, de, ru, and pt are actually in English and are the same. I didn't check if any others exist. Does this PR make en match? No. At least line 20 is different here than in the other files.
In an ideal implementation, we wouldn't have multiple files that have essentially the same content. I recommend we make all the files match for this PR and raise the issue of redundancy in the implementation elsewhere.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll see what I can do.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dtowell: It would be nice if you could incorporate @davidhutchens's suggestion so that this PR can be merged.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me except for the issue raised by @davidhutchens!
Hello everyone. While it's easy to redirect tree pages from the help window, it's more time-consuming to remove them from the pages themselves. I propose to replace the pages in pt and ru with pages that redirect to the en version. This French page is certainly one of my mistakes. :-) We'll have to discuss how I'm going to get all this into the Logisim-evolution repository. |
@mbaillif: I agree with your suggestions. @dtowell or @mbaillif: Could one of you address the suggestions by @davidhutchens so that we can merge this contribution? |
Restore English test vector documentation. Correct a few related typos.