Skip to content

Commit

Permalink
Note that sections are linked to
Browse files Browse the repository at this point in the history
  • Loading branch information
crowbot committed Feb 6, 2015
1 parent fbcf239 commit 28eaad1
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/customising/themes.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,12 +182,14 @@ unused).

## Customising the help pages

If you're running Alaveteli in another language, you'll want to show
The help pages are a really important part of an Alaveteli site. If you're running Alaveteli in another language, you'll want to show
your users localised versions of the help pages. Even if you're running
the site in English, the default help pages in Alaveteli are taken from
WhatDoTheyKnow, and are therefore relevant only to the UK. You should
take these pages as inspiration, but review their content with a view to
your jurisdiction. The important pages to customise and translate are:
your jurisdiction.

The important pages to customise and translate are listed here. We note where Alaveteli links to these pages (sometimes to anchors for particular sections within the pages) or takes users directly to them.

* [About](https://github.com/mysociety/alaveteli/blob/master/app/views/help/about.html.erb): why the website exists, why it works, etc
* [contact](https://github.com/mysociety/alaveteli/blob/master/app/views/help/contact.html.erb): how to get in touch
Expand Down

1 comment on commit 28eaad1

@garethrees
Copy link
Member

Choose a reason for hiding this comment

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

The important pages to customise and translate are listed here. We note where Alaveteli links to these pages (sometimes to anchors for particular sections within the pages) or takes users directly to them.

I'm +1 on the thinking here, but maintaining these will be pretty hard work. Would it be better (and not a major effort) to have a script that greps for `help_about_path(:anchor => 'blah') and then checks that the template exists with the anchor target?

Please sign in to comment.