lencx / ChatGPT

🔮 ChatGPT Desktop Application (Mac, Windows and Linux)
https://nofwl.com
52.32k stars 5.88k forks source link

[Bug] Markdown notes directory stalls and wont close correclty after save of consecutive MD chats. #267

Open shaungt1 opened 1 year ago

shaungt1 commented 1 year ago

Version

V0.10.1

Bug description

When trying to save consecutive chats to markdown the C:\Users\Frontside.chatgpt\notes directory that opens up freezes and is somtimes unable to close. It might be more advantageous to actually NOT open the "notes" directory folder and simply show a message that it was saved successfully and add a link in the control center to give physical access to the markdown files? This could prove to reduce load time on the system and the app?

Also I did not see any contribute docs in this main project? but I would like to contribute if you are taking in outside devs?

OS

Windows 10 & Ubuntu 20.04

Environment

No response

lencx commented 1 year ago

It does get a bit annoying if you export files frequently, I can optimize it in the next version.

You can always contribute documentation, writing documentation for the operation is too too tedious, so no documentation work has been done for now. Many features come with hints for users to try.

shaungt1 commented 1 year ago

Yeah that would be great Ill help with documentation np! do you have any guidelines expectations, or meetups, discord, etc so I can make sure to document project corecctly to your standards?

lencx commented 1 year ago

The biggest problem with the current project is that the readme is too long, so we can structure it. There is an introduction section, a FAQ section, a tips section (shortcuts, script injection, etc.) and others. You can create a docs directory under the project root path to write the documentation.

There are not too many requirements for the time being, so if you have time, you can always contribute. https://github.com/lencx/ChatGPT/issues/264

shaungt1 commented 1 year ago

The biggest problem with the current project is that the readme is too long, so we can structure it. There is an introduction section, a FAQ section, a tips section (shortcuts, script injection, etc.) and others. You can create a docs directory under the project root path to write the documentation.

There are not too many requirements for the time being, so if you have time, you can always contribute. #264

Sounds good ill start working on that today and try to get a pull request in this weekend

shaungt1 commented 1 year ago

The biggest problem with the current project is that the readme is too long, so we can structure it. There is an introduction section, a FAQ section, a tips section (shortcuts, script injection, etc.) and others. You can create a docs directory under the project root path to write the documentation. There are not too many requirements for the time being, so if you have time, you can always contribute. #264

Sounds good ill start working on that today and try to get a pull request in this weekend

Do you want CONTRIBUTE doc and CODE OF CONDUCT docs to ? I can propose these as well?

lencx commented 1 year ago

Yes, you can, if you can write it, or you can also refer to the contribution guidelines of popular open source projects.

shaungt1 commented 1 year ago

you can also refer to the contribution guidelines of popular open source projects.

I finished a rough draft of the new docs. it would not let me assign you as a reviewer so I just wanted to make you aware PR: https://github.com/lencx/ChatGPT/pull/285

lencx commented 1 year ago

@shaungt1 I found that the content was too spread out after the files were divided by structure and it became difficult to do internationalization. I created a website on how to use the ChatGPT desktop application (https://github.com/lencx/app), which is built on Docusaurus which is more suitable for writing documentation. Of course all the work you do makes perfect sense, and we can migrate some of it.

The content about the README really needs to be streamlined, but I don't have a clear structure at the moment. It seems to me that Install, Feature and Thanks in the README are required. And the code contribution guidelines.

Again, thank you for the tremendous amount of work I have seen you do, thank you.

What do you think?

shaungt1 commented 1 year ago

No problem glad to help, so you want only the Install, Feature, Thanks and Contributing on the initial README? and link to the official docs website in the link you provided as well?

Might be advantageous to work through or outline your ideas for each section if you want to leave notes in the pull request on what your expectations are I can go ahead and start getting them changed to meet your preferences.

Need to know know how should we address: Which categories are staying in the "Contents" section where you want to link or display awesome prompts instructions? where you want to link or display AWESOME.md with the resources LINKS where you want to link or display Announcements where you want to link or display FAQ where to link or display Platform, Build, and Deployment Status Where we want to link or display Previews Features ( what content or links should go here) where you want to link or display local development Also which categories / sections I added we should remove Should the sub header for Install be Getting started or Install?

Let me know based on each of those section which should if they should be reverted back to original text ? or if we should keep the new structure per category and if we need additional details? we might want to move all this to the PR

shaungt1 commented 1 year ago

Moved the conversation to https://github.com/lencx/ChatGPT/pull/285