Skip to content

docs: enhance documentation UX and visual hierarchy - #25

Open
vveerrgg wants to merge 4 commits into
gzuuus:masterfrom
vveerrgg:docs/improve-documentation-layout
Open

docs: enhance documentation UX and visual hierarchy#25
vveerrgg wants to merge 4 commits into
gzuuus:masterfrom
vveerrgg:docs/improve-documentation-layout

Conversation

@vveerrgg

@vveerrgg vveerrgg commented Feb 6, 2025

Copy link
Copy Markdown

Key Improvements:

  • Streamline documentation flow with logical section ordering
  • Implement consistent typography and spacing system
  • Enhance component styling for better readability
  • Fix icon alignment and spacing for better visual harmony
  • Remove redundant components to reduce maintenance overhead

Visual Updates:

  • Standardize heading sizes and weights
  • Add proper vertical rhythm between sections
  • Improve list item spacing and indentation
  • Align icons with text using flexbox
  • Update text colors for better contrast

These changes make the documentation more professional, easier to navigate, and maintain consistency with Nostree's design system.

- Update component styling for better consistency
- Remove redundant documentation components
- Improve spacing and typography
- Fix icon alignment issues
@vveerrgg

vveerrgg commented Feb 6, 2025

Copy link
Copy Markdown
Author

Visual Changes

Before

![Before changes]Screenshot 2025-02-05 at 10 01 38 PM

After

![After changes]Screenshot 2025-02-05 at 10 00 56 PM

@gzuuus gzuuus left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Thanks for your pr, there are couple issues to solve before we can get this merged, but good one! 🤙

Comment thread src/routes/docs/+page.svelte Outdated
@@ -1,14 +1,190 @@
<script lang="ts">
import InfoDialog from "$lib/components/info-dialog.svelte";

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

You have to remove the unused imports, since InfoDialog contains two imports that doesn't exist any more, and that break the docs page

  import DocNewList from "$lib/docsComponents/doc-new-list.svelte";
  import DocOldLists from "$lib/docsComponents/doc-old-lists.svelte";

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Noob errors on my part ... thank you for the catch / review.

Comment thread src/routes/docs/+page.svelte Outdated
<hr class="my-8">

<section class="mb-12">
<h2 class="text-2xl md:text-3xl font-semibold mb-4 mt-8">Migrating Old Lists</h2>

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

This section Migrating Old Lists Doesn't make too much sense, there are no import option

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

my mistake ... originally I'd been experimenting with an idea related to adding language localization etc. which evolved into NIP-74... I forgot to remove that bit ...

- Remove migration section as it's not currently implemented
- Simplify documentation flow
- Focus on core features
- Remove unused imports
- Remove unused components
- Simplify dialog implementation
- Clean up styling
- Remove default export attempt (not needed in Svelte)
- Fix type issues by making props required with defaults
- Clean up component structure
@vveerrgg

vveerrgg commented Feb 6, 2025

Copy link
Copy Markdown
Author

fixed the bug preventing login as well. I missed a couple of IDE errors that I only caught after testing it locally. Got a bit ahead of myself & excited to contribute.

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