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

Differences from Atom #156

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Differences from Atom #156

wants to merge 3 commits into from

Conversation

mauricioszabo
Copy link
Contributor

No description provided.

@Daeraxa
Copy link
Member

Daeraxa commented Dec 23, 2022

I'm trying to think where this should actually go, it seems in a bit of an odd place at the moment.
Maybe it should be integrated into the FAQ? Or in resources (under some kind of new section?).

Copy link
Member

@confused-Techie confused-Techie left a comment

Choose a reason for hiding this comment

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

I'm personally fine with where this message appears.

As this document doesn't seem aimed at the everyday user as it's a bit more technical, so it makes sense to be away as a section of docs, rather than something to appear on the Homepage.

Although I'm not sure if we will always need this document or how hard it'll be to update after some time, but for right now can probably answer some of the burning questions and should be linked on our org wide readme once merged.

@mauricioszabo
Copy link
Contributor Author

I think, when Atom is forgotten and Pulsar becomes more popular, we can basically remove this page, WDYT @confused-Techie ?

@confused-Techie
Copy link
Member

I think, when Atom is forgotten and Pulsar becomes more popular, we can basically remove this page, WDYT @confused-Techie ?

Yeah I think that's a great idea. Keep this and keep updating it for likely a few months maybe a year or so, then we can delete it, and at the same time will probably need to make sure to update our FAQ as that's focused on the questions we got when we first split from Atom-Community

@confused-Techie
Copy link
Member

@mauricioszabo Do you want me to take a look at some of the Flags from the Spell Checker so we can get this one merged?

@Daeraxa
Copy link
Member

Daeraxa commented Dec 28, 2022

I still feel the placement of the doc feels a bit odd. It is just a link from the main docs index which makes it unusual - other items are linked to from the sidebar which the index is really meant to be an alternative to - therefore to match this either needs its own parent in the sidebar or it should be placed somewhere else.

Personally I'd place it in the root of Resources or even as a new heading in about-us

@confused-Techie
Copy link
Member

@Daeraxa Yeah I'd be on board with moving it as it's own header in "About Us" does feel rather natural there

Copy link
Member

@Daeraxa Daeraxa left a comment

Choose a reason for hiding this comment

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

Just a few small grammatical or readability suggestions for the main content, otherwise very little to find fault with.

docs/docs/differences-from-atom/index.md Outdated Show resolved Hide resolved
docs/docs/differences-from-atom/index.md Outdated Show resolved Hide resolved
docs/docs/differences-from-atom/index.md Outdated Show resolved Hide resolved
docs/docs/differences-from-atom/index.md Outdated Show resolved Hide resolved
docs/docs/differences-from-atom/index.md Outdated Show resolved Hide resolved
docs/docs/differences-from-atom/index.md Outdated Show resolved Hide resolved
docs/docs/differences-from-atom/index.md Outdated Show resolved Hide resolved
docs/docs/differences-from-atom/index.md Outdated Show resolved Hide resolved
docs/docs/differences-from-atom/index.md Outdated Show resolved Hide resolved
docs/docs/differences-from-atom/index.md Outdated Show resolved Hide resolved
@Daeraxa
Copy link
Member

Daeraxa commented Dec 31, 2022

@mauricioszabo continuing from the conversation on where to put it, what do you think about the above proposals to simply move the text into the about.md page?

I think in the near future there will be a lot of reshuffling of this anyway to make this more obvious and get it all in one place.

It sounds like I'm being picky but honestly my main concern is that with the PR the way it is, people simply won't find the link to this section at all.

In the long term I think my solution would be to have a new top level category "About Pulsar" in which we will have this document + the various sections at the start of the manual. Or even split out "resources" into something more meaningful, it isn't like we are at a premium for space in the sidebar.

@mauricioszabo
Copy link
Contributor Author

@Daeraxa no problem for me moving to About :)

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.

3 participants