Documentation Pages - Githubissues

jasononeil / haxelib

Provisional project for the Haxe 3 related haxelib changes.

0 stars 0 forks source link

Documentation Pages #8

Open jasononeil opened 9 years ago

jasononeil commented 9 years ago

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

Simn commented 9 years ago

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 commented 9 years ago

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 https://github.com/jasononeil/haxelib/issues/8#issuecomment-76527500.

Simn commented 9 years ago

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 commented 9 years ago

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 https://github.com/jasononeil/haxelib/issues/8#issuecomment-76532080.

Simn commented 9 years ago

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