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: update installation guide #664

Merged
merged 6 commits into from
Nov 22, 2023
Merged

docs: update installation guide #664

merged 6 commits into from
Nov 22, 2023

Conversation

henryh0x1
Copy link
Contributor

@henryh0x1 henryh0x1 commented Nov 20, 2023

The purpose of this pull request is to restructure the installation documentation #632
This pull request also resolved all the conservations in the closed PR #634

@henryh0x1 henryh0x1 added type: documentation Improvements or additions to documentation type: enhancement New feature or request labels Nov 20, 2023
@dan-homebrew
Copy link
Contributor

@hieu-jan I'll open a PR to this branch, with some WIP changes. Easier for me to explain by writing.

@dan-homebrew
Copy link
Contributor

dan-homebrew commented Nov 20, 2023

@hieu-jan @hahuyhoang411 For Documentation, one common piece of feedback for both of you is to make your writing concise and succinct. Short sentences, 1-2 line paragraphs, more images, code blocks. Avoid walls of text.

Fortunately for us, we're working on the very technology that helps us with this: LLMs!

I have found Codellama 34b to be fairly good, but you should experiment with ChatGPT as well.

I use the following prompt:

Please transform the following text into a technical documentation format. The new document should be professional, clear, and concise, providing detailed and organized information. It should maintain a formal tone, avoid colloquial language, and be structured with clear headings and bullet points where necessary. The content should be neutral in sentiment, focusing on delivering factual information in a straightforward manner. If applicable, include code blocks, file paths, or URLs to enhance the technical specificity. 

Here is the text to be transformed: [Insert your text here]

@dan-homebrew
Copy link
Contributor

@hieu-jan I have done an example of this on the "Installing Jan on Windows" PR here.

While I'm against step-by-step instructions, I would recommend having an image to break up the monotony (e.g. an image of the Windows installer at the top of the screen)

#666

@henryh0x1
Copy link
Contributor Author

@dan-jan Thanks for your valuable feedback. I will update these docs asap!

@hiento09
Copy link
Collaborator

@hieu-jan , please rebase main by clicking to Update Branch or via console then the feature Preview URL for PR will be applied to this PR
image

Copy link
Contributor

@0xSage 0xSage left a comment

Choose a reason for hiding this comment

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

lgtm!

imo installation/overview can be even shorter. but this is a great start!

@henryh0x1 henryh0x1 merged commit fb23e3d into main Nov 22, 2023
1 check passed
@henryh0x1 henryh0x1 deleted the docs/install branch November 22, 2023 00:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation type: enhancement New feature or request
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

4 participants