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 #10

Open
csainty opened this issue Mar 19, 2012 · 1 comment
Open

Documentation #10

csainty opened this issue Mar 19, 2012 · 1 comment

Comments

@csainty
Copy link
Member

csainty commented Mar 19, 2012

I followed through the readme, but still had to dig into the code a few times.

First problem was that I didn't think it was clear the code expected the resource file to be called Language.resx
https://github.com/Code52/aspnet-internationalization/blob/master/src/Code52.i18n.MVC/NuSpec/Content/App_Readme/Code52.i18n.MVC.readme.txt.pp#L14

The code that expects this to be the name is here
https://github.com/Code52/aspnet-internationalization/blob/master/src/Code52.i18n.MVC/NuSpec/Content/Controllers/LanguageController.cs.pp#L52

Second problem is that it does not explain how to go about configuring your supported cultures.
There is this code
https://github.com/Code52/aspnet-internationalization/blob/master/src/Code52.i18n.MVC/NuSpec/Content/Controllers/LanguageController.cs.pp#L14

This code
https://github.com/Code52/aspnet-internationalization/blob/master/src/Code52.i18n.MVC/NuSpec/Content/Code52.i18n/CultureHelper.cs.pp#L18

And this code
https://github.com/Code52/aspnet-internationalization/blob/master/src/Code52.i18n.MVC/NuSpec/Content/Views/Shared/LanguageSelection.ascx#L13

All of which seem to be defining what the supported list of cultures are, none of those lists match and none of the docs explain which ones to change.

@shiftkey
Copy link
Member

I'll start a PR on this, as there's a few places that we can/should use for this information

  • gh-pages branch - first time users, is that a better spot for documentation after install?
  • App_Readme file - doesn't always appear to users after installing package due to EnvDTE reloading the csproj file
  • README.md in repository root - what should live here?

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

No branches or pull requests

2 participants