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 on github pages #182

Merged
merged 19 commits into from
Oct 8, 2014
Merged

Documentation on github pages #182

merged 19 commits into from
Oct 8, 2014

Conversation

malukenho
Copy link
Collaborator

Reference to #181

@@ -0,0 +1,270 @@
<!DOCTYPE html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7" id="top"> <![endif]-->
Copy link
Owner

Choose a reason for hiding this comment

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

we can skip anything IE...

malukenho added 9 commits October 4, 2014 23:07
- Link the new page in all places needed
- Put links where is necessary for new documentation page
- Remove unecessary headers for IE old versions (nedded by @Ocramius)
- Modify metatags to optmize searches robots
- Add links to menu on all pages
- Fix footer on css
- Reduce css rules
- Put right links on `index.html` section for `Access interceptor value
  holder`
- Create documentation page for `Tuning the ProxyManager for production`
- Fix favicon path in all html files
@malukenho
Copy link
Collaborator Author

@Ocramius need review.

@Ocramius
Copy link
Owner

Ocramius commented Oct 7, 2014

Few issues that I found:

Homepage

homepage

  • As you can see, the homepage does not describe what the library is about
  • The installation should probably be moved to the "download" page

Menu

menu

The menu is quite nice, but the DOWNLOAD link should lead to a page teaching how to install the library. Additionally, the menu makes things a bit messy on mobile.

Top nav

top nav

The github link in the top nav does not respect CaseSEnsItIvity of the URL, and the GITHUB link may be replaced with the octocat SVG.

Header:

header

This header seems to be repeated on all pages: the homepage should be enough. Eventually, consider adding the logo at the top of the menu instead.

Credits:

credits

May want to add a list of contributors here, including yourself

Copyright:

Currently doesn't display anything: should contain a plaintext copy (may use code highlighting) of the MIT license.

Talk:

May want to add a page with the talk at https://www.youtube.com/watch?v=Ka8wlV8M6Vg

Footer:

  • remove the (c) Marco Pivetta
  • may repeat the navigation here as well instead
  • may repeat the "Fork" and "Star" links here as well

@Ocramius
Copy link
Owner

Ocramius commented Oct 7, 2014

Also needed: an index.html page with a refresh http-equiv header, so that people are brought to the correct subdirectory

@Ocramius
Copy link
Owner

Ocramius commented Oct 7, 2014

Can you also rename docs_html to html-docs?

@malukenho
Copy link
Collaborator Author

@Ocramius done

@Ocramius Ocramius added this to the 1.0.0 milestone Oct 8, 2014
@Ocramius Ocramius self-assigned this Oct 8, 2014
@Ocramius Ocramius changed the title [WIP] Documentation on github pages Documentation on github pages Oct 8, 2014
@Ocramius Ocramius merged commit b680128 into Ocramius:master Oct 8, 2014
Ocramius added a commit that referenced this pull request Oct 8, 2014
Ocramius added a commit that referenced this pull request Dec 12, 2014
Total issues resolved: **17**
- [108: Fix windows path length limitations](#108)
- [172: Alternate hotfix for #108 - windows path length limitations](#172)
- [178: Verify type-safety with `self` and `static` type-hints](#178)
- [180: #178 - `self` type safety check](#180)
- [181: Documentation should be released on github pages on the `gh-pages` branch.](#181)
- [182: Documentation on github pages](#182)
- [187: Proxy generation fails if magic methods are marked as final](#187)
- [189: Bugfix - cannot override final methods ( #187 )](#189)
- [190: [WIP] [EXPERIMENTAL] Codegen should not trigger fatals](#190)
- [191: Put link of documentation on README.md and Close #185](#191)
- [193: [WIP] Codegen errors](#193)
- [194: Code-generation fatal error prevention](#194)
- [195: Blogpost about 1.0.0, 2.0.0 and stability frames](#195)
- [196: Define maintainance time-frames (stable/oldstable/etc)](#196)
- [198: Highlighting the code examples](#198)
- [199: Removed unused `ReflectionMethod` import](#199)
- [202: #196 - adding document with expected stability time-frames](#202)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants