Skip to content
This repository has been archived by the owner on Mar 3, 2023. It is now read-only.

Doc updates #1052

Merged
merged 18 commits into from
Oct 30, 2013
Merged

Doc updates #1052

merged 18 commits into from
Oct 30, 2013

Conversation

gjtorikian
Copy link
Contributor

Resolves #1024.

This brings the Changer package tutorial a bit up-to-date. A few things to note:

  • I feel pretty strongly about keeping the general package creation docs separate from the "creating your first package!" docs. One is a reference, the other is a tutorial. In the interest of not keeping a giant page, I split the two parts.
  • I wouldn't merge just yet. I'll still likely need to update theme-variables.md and the companion "Your first theme!" docs
  • Not that my code is perfect and marvelous, but it might be time to use panda-docs (or some other module) to handle the creation of a mini-docs site, complete with a TOC, anchors for headings, and all that jazz

/cc @benogle @mcolyer

@mcolyer
Copy link
Contributor

mcolyer commented Oct 29, 2013

I'd really rather see the guide/tutorial more intertwined than they are currently which is why I put them together. I think organizing our documentation around tasks (get started, create a theme, create a package) makes it simpler to find what you're looking for if you're new.

That said I'm also not the one putting the time in on it, so ultimately I leave it up to you.

@benogle
Copy link
Contributor

benogle commented Oct 29, 2013

I agree with @gjtorikian. Having the example jammed in there makes it hard to find. We can link to the example in the beginning of the reference/info section of the package doc.

Change the event to `changer:magic` and reload the editor:

```json
"activationEvents": ["changer:toggle"]
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this be changer:magic?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch !

@benogle
Copy link
Contributor

benogle commented Oct 30, 2013

Other than my one comment, I like this

gjtorikian added a commit that referenced this pull request Oct 30, 2013
@gjtorikian gjtorikian merged commit c30f63f into master Oct 30, 2013
@gjtorikian gjtorikian deleted the doc-updates branch October 30, 2013 22:59
@gjtorikian
Copy link
Contributor Author

@benogle Rather than refer to local files, I ended up linking out to GitHub's cloud asset host: https://github.com/atom/atom/pull/1052/files#diff-6b8aea9919633dfccd46cb74e4735766R330

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Revisit the package creation doc/example
3 participants