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

doc directory is becoming a little untidy due to number of different files in a flat structure #245

Closed
DavidAntliff opened this issue Jul 19, 2016 · 4 comments
Assignees
Milestone

Comments

@DavidAntliff
Copy link
Collaborator

Might be tidier to put images into a subdirectory, at the very least. That would make the .md files easier to find.

@TonyWalsworthImg
Copy link
Contributor

True, but the .md files are designed to be navigated via linkage from the top level rather than searched out individually so it really doesn't matter if the /doc folder is untidy. I can agree with you from a documentation/editing perspective though. I'm happy to move all of the images to a doc/images/ sub folder and then go through the .md files to change the source path for each image. Will take me a couple of hours probably. This obviously won't change the look and feel from the reader's perspective. It's just folder housekeeping.

@DavidAntliff
Copy link
Collaborator Author

Ok, if you're happy to do so. If you move the images into a subfolder then ask @seank-img to show you a clever sed trick to scrape the filenames from images/* and pipe through sed to rename the paths internally, it will take only a few seconds, and save you couple of hours :)

@seank-img
Copy link
Contributor

Something like...
(cd doc; mkdir images; ls -1 *.png | xargs -I '{}' sh -c 'sed -i "s|\({}\)|images/\\1|g" *.md; git mv {} images/{}; git add *.md;')

DavidAntliff added a commit to DavidAntliff/AwaLWM2M that referenced this issue Jul 19, 2016
@DavidAntliff
Copy link
Collaborator Author

@seank-img yes, that works well, I've put it in a PR - since I raised the issue, only fair I run and verify your fix. Thanks for the correct magical incantation.

@DavidAntliff DavidAntliff added this to the 0.2.2 milestone Jul 19, 2016
seank-img added a commit that referenced this issue Jul 20, 2016
Move doc images to their own subdirectory. Closes issue #245.
@seank-img seank-img modified the milestones: 0.2.3, 0.2.2 Jul 22, 2016
@delmet delmet closed this as completed Jul 27, 2016
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

4 participants