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

Documentation Pages #8

Open
3 of 11 tasks
jasononeil opened this issue Feb 28, 2015 · 5 comments
Open
3 of 11 tasks

Documentation Pages #8

jasononeil opened this issue Feb 28, 2015 · 5 comments

Comments

@jasononeil
Copy link
Owner

  • Creating a haxelib
  • FAQ
  • Installation
  • Using Haxelib
  • Remoting API and JSON API
  • Contributing to Haxelib
  • About Haxelib
  • Tips and Tricks
  • Menu styling
  • Menu ordering
  • Load top navbar menu from the actual page list, rather than hard-coding them.
@Simn
Copy link
Collaborator

Simn commented Feb 28, 2015

I would like to avoid duplication with the manual content here. I don't have a good strategy for that right now but we should keep that in mind.

@jasononeil
Copy link
Owner Author

Perhaps we can leave the dropdown there, but it links to pages in the Haxe
manual?

If any content isn't considered worthy for the manual, perhaps it's not
worthy for this site either. (Except for things specific to the website,
like information about the JSON api etc)

On Sat, Feb 28, 2015 at 10:10 PM, Simon Krajewski notifications@github.com
wrote:

I would like to avoid duplication with the manual content here. I don't
have a good strategy for that right now but we should keep that in mind.


Reply to this email directly or view it on GitHub
#8 (comment).

@Simn
Copy link
Collaborator

Simn commented Feb 28, 2015

Ideally the manual would focus on the usage of the haxelib client with the website having additional documentation on how to interact with it (the website).

The problem with just opening the pages in the manual is that you lose context. I'm thinking we should have the documentation in one place (the manual) and export the haxelib information to two places (the manual and the website).

@jasononeil
Copy link
Owner Author

I guess it would be easy enough to scrape the exported markdown and display
it inline then.

Would you want to set up another Github hook to be alerted to changes, or
is it enough to run it manually / when we deploy an update?

On Sun, Mar 1, 2015 at 12:07 AM, Simon Krajewski notifications@github.com
wrote:

Ideally the manual would focus on the usage of the haxelib client with the
website having additional documentation on how to interact with it (the
website).

The problem with just opening the pages in the manual is that you lose
context. I'm thinking we should have the documentation in one place (the
manual) and export the haxelib information to two places (the manual and
the website).


Reply to this email directly or view it on GitHub
#8 (comment).

@Simn
Copy link
Collaborator

Simn commented Feb 28, 2015

Manually is fine for now, it's not like we have documentation updates on a regular basis for that.

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

No branches or pull requests

2 participants