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: Reorganize user guide #2050

Merged
merged 30 commits into from
Aug 28, 2024
Merged

docs: Reorganize user guide #2050

merged 30 commits into from
Aug 28, 2024

Conversation

SuaYoo
Copy link
Member

@SuaYoo SuaYoo commented Aug 27, 2024

Resolves #2041

Note: If this is ready to be merged before #2020 we'll need to comment out the org settings "Crawl Workflows" section.

Reorganizes user guide to be more solutions based. For the most part, I kept the content the same but moved sections into separate files.

New/overhauled pages:

Feel free to commit suggestions directly.

Copy link
Member

@Shrinks99 Shrinks99 left a comment

Choose a reason for hiding this comment

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

There IS a quick way of collapsing the sidebar! I've disabled the feature that prevents that in d34512f, probably better this way for the reorg you've done. 👍

  • Added some colour changes (moves things in-line with other colours selected for the website
  • Fixed some ID links
  • Slightly adjusted the language on the sign up page

Overall I like this a lot! I'm sort of surprised it didn't take as much re-writing as I had thought heh. Sign up page looks good!

I would like to move the content on the index page to a more complete "first crawl" guide, but I think we should do that later.

@SuaYoo SuaYoo requested a review from Shrinks99 August 27, 2024 19:50
SuaYoo added a commit that referenced this pull request Aug 27, 2024
Copy link
Member

@emma-sg emma-sg left a comment

Choose a reason for hiding this comment

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

Nice! Left a bunch of capitalization suggestions, along with a few questions

docs/user-guide/browser-profiles.md Outdated Show resolved Hide resolved
docs/user-guide/collection.md Outdated Show resolved Hide resolved
docs/user-guide/collections.md Outdated Show resolved Hide resolved
docs/user-guide/crawl-workflows.md Outdated Show resolved Hide resolved
docs/user-guide/crawl-workflows.md Outdated Show resolved Hide resolved
docs/user-guide/running-crawl.md Outdated Show resolved Hide resolved
docs/user-guide/signup.md Outdated Show resolved Hide resolved
docs/user-guide/signup.md Outdated Show resolved Hide resolved
docs/user-guide/signup.md Outdated Show resolved Hide resolved
docs/user-guide/user-settings.md Outdated Show resolved Hide resolved
SuaYoo and others added 2 commits August 27, 2024 14:32
Co-authored-by: Emma Segal-Grossman <[email protected]>
Co-authored-by: Emma Segal-Grossman <[email protected]>
SuaYoo and others added 2 commits August 27, 2024 16:52
Co-authored-by: Tessa Walsh <[email protected]>
Co-authored-by: Emma Segal-Grossman <[email protected]>
@SuaYoo SuaYoo requested review from tw4l, emma-sg and CamilleLaw1 August 27, 2024 23:58
@@ -25,34 +25,50 @@
src: url('../assets/fonts/Inter-Italic.var.woff2') format('woff2');
font-feature-settings: "ss03";
}

@font-face {
font-family: 'Konsole';
Copy link
Member

Choose a reason for hiding this comment

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

woohoo!

Copy link
Member

Choose a reason for hiding this comment

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

heh, probably should have made this a separate PR... Sorry Sua 🙃

Copy link
Member Author

Choose a reason for hiding this comment

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

NBD looks good!

Copy link
Member

@tw4l tw4l left a comment

Choose a reason for hiding this comment

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

A few relatively minor grammatical changes and nits but overall this is fantastic! Excellent work :)

docs/user-guide/archived-items.md Outdated Show resolved Hide resolved
docs/user-guide/running-crawl.md Outdated Show resolved Hide resolved
docs/user-guide/workflow-setup.md Outdated Show resolved Hide resolved
@SuaYoo SuaYoo merged commit ecac4f6 into main Aug 28, 2024
@SuaYoo SuaYoo deleted the user-guide-reorg branch August 28, 2024 16:50
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.

[Feature]: Improve self-service support
4 participants