Re: Directory and File naming conventions

The .md files get built by Jekyll on our CI server. The results end up here: http://apacheroyaleci.westus2.cloudapp.azure.com:8080/job/RoyaleDocs_Stagin g/lastSuccessfulBuild/artifact/_site/ HTH, -Alex On 1/24/18, 2:21 PM, "carlos.rov...@gmail.com on behalf of Carlos Rovira"

Re: Directory and File naming conventions

Hi, I see you work in develop thought GitHub with .md files. I can see as well .css with website fonts. But I don't know how to see the generated site. Can someone explain me how to see the final html content resulting from apply the css to the markdown files? Thanks 2018-01-24 22:13 GMT+01:00

Re: Directory and File naming conventions

OK, I'm done playing in the Welcome folder. The third-tier TOC seems to be working. I am moving on to the CreateAnApplication folder. -Alex On 1/24/18, 12:10 PM, "Andrew Wetmore" wrote: >I should have added that I will go edit out the hyphens in the front >matter. > >On

Re: Directory and File naming conventions

On 1/24/18, 9:59 AM, "Alex Harui" wrote: >Hi Andrew, > >Thanks for doing the research. I didn't even think about "-". That seems >like a good idea to me. Speaking of '-', I saw in your recent commit that the Front Matter title had '-' in it. That title becomes the

Re: Directory and File naming conventions

On 1/24/18, 10:07 AM, "Andrew Wetmore" wrote: >My argument for sentence case over title case is that, in general, fewer >capital letters makes for easier scanning and comprehension, especially >for >folks for whom English is not the first or a comfortable language. OK, If

Re: Directory and File naming conventions

My argument for sentence case over title case is that, in general, fewer capital letters makes for easier scanning and comprehension, especially for folks for whom English is not the first or a comfortable language. I do not have time today to scrub existing files and the table of contents, and I

Re: Directory and File naming conventions

Hi Andrew, Thanks for doing the research. I didn't even think about "-". That seems like a good idea to me. I think of page titles and TOC entries as chapter titles in books so my first instinct is to use title case, but if you really want to use sentence case, that's fine with me. I feel the

Re: Directory and File naming conventions

From a quick and non-comprehensive review: - Practis [1] recommends using all lower case, with no spaces, for file names, with _ or - to join words and no other punctuation. - Huridocs [2] concurs and suggests some tools for doing bulk file renaming. - Winthrop University[4]

Re: Directory and File naming conventions

HI Andrew, Good question. I'm pretty sure I don't care as long as it meets usability goals. Maybe you already know what usability goals a "help docs" site should have, but maybe we should first agree on usability goals and work backwards to how the directory and file names affect that if at