Skip to content

Add about page#47

Merged
braver merged 11 commits intogh-pagesfrom
about-page
Jul 26, 2025
Merged

Add about page#47
braver merged 11 commits intogh-pagesfrom
about-page

Conversation

@braver
Copy link
Copy Markdown
Member

@braver braver commented Jul 5, 2025

You can mostly ignore the related layout changed and focus on the about.md. The goal for this document is twofold:

  • Explain to anyone visiting the site on their own, or once we start to expose it more widely, why this site and the new crawler exist next to packagecontrol.io. This explanation is probably temporary and might eventually find its way to the documentation.
  • Create a place to clearly communicate the new channel.json URL (and to make it a short URL served by the site instead of via GitHub release assets - many reasons for which already given by deathaxe on Discord).

Fixes #4

Any feedback, proof-reading, spotting typos, etc. all very much welcome.


Scherm­afbeelding 2025-07-05 om 21 37 25

@braver braver self-assigned this Jul 5, 2025
Comment thread about.md Outdated
Copy link
Copy Markdown
Contributor

@michaelblyons michaelblyons left a comment

Choose a reason for hiding this comment

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

Commas. So many commas.

Comment thread about.md Outdated
Comment thread about.md Outdated
Comment thread about.md Outdated
Comment thread about.md Outdated
Comment thread about.md Outdated
Comment thread about.md Outdated
Co-authored-by: Michael <2701605+michaelblyons@users.noreply.github.com>
@deathaxe
Copy link
Copy Markdown
Contributor

deathaxe commented Jul 6, 2025

Does it make sense to prepare a structure for multiple static doc-like sites by organizing md files in a pages/ sub directory or something along those lines or do you plan to put descriptions about how to submit packages etc. to docs.sublimetext.io?

@braver
Copy link
Copy Markdown
Member Author

braver commented Jul 6, 2025

or do you plan to put descriptions about how to submit packages etc. to docs.sublimetext.io?

I’ve gone back and forth about this but I think that’s ideal. It puts all relevant documentation for package authors in one place. So this website should have only one about page, and a short one at that.

@deathaxe
Copy link
Copy Markdown
Contributor

deathaxe commented Jul 6, 2025

Than the about page should probably link to those pages once they exist or main page provide a link to them.

@deathaxe
Copy link
Copy Markdown
Contributor

deathaxe commented Jul 6, 2025

Maybe add a link to navigate pack home?

@FichteFoll
Copy link
Copy Markdown
Member

Maybe add a link to navigate pack home?

Clicking on the page title on the top left navigates to home from every page (since it exists on every page). I don't think we need another dedicated link for this.


Will review the actual PR later.

@deathaxe
Copy link
Copy Markdown
Contributor

deathaxe commented Jul 7, 2025

Clicking on the page title on the top left navigates to home from every page

This wasn't to obvious to notice, yet.

@braver
Copy link
Copy Markdown
Member Author

braver commented Jul 7, 2025

Clicking on the page title on the top left navigates to home from every page

And it works that way on basically every single website out there. Still, people always ask for a clear and explicit link to the homepage, and I’m not against giving it to them.

@deathaxe
Copy link
Copy Markdown
Contributor

deathaxe commented Jul 7, 2025

Low priority. When starting with sublimetext.io landing package to navigate to packages, the question actually would be what a "Home" link should point to. So if there's a way back, that's ok. Me not having noticed that is probably a individual issue.

Comment thread about.md Outdated
@michaelblyons
Copy link
Copy Markdown
Contributor

or do you plan to put descriptions about how to submit packages etc. to docs.sublimetext.io?

I’ve gone back and forth about this but I think that’s ideal. It puts all relevant documentation for package authors in one place.

Cross-linking to sublimetext-io/docs.sublimetext.io#134

@braver
Copy link
Copy Markdown
Member Author

braver commented Jul 26, 2025

I'm going to merge this now to keep things moving, but any future review, corrections and improvements of the texts are more than welcome. Once the docs are live this needs to be updated anyway.

@braver braver merged commit b0ebcb5 into gh-pages Jul 26, 2025
@braver braver mentioned this pull request Jul 26, 2025
3 tasks
@deathaxe deathaxe deleted the about-page branch July 26, 2025 10:37
@deathaxe
Copy link
Copy Markdown
Contributor

Finally can switch to new channel, yeah.

@braver
Copy link
Copy Markdown
Member Author

braver commented Jul 26, 2025

🎉

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.

4 participants