Skip to content

Commit bed86cf

Browse files
authored
Update README.md
1 parent d926d89 commit bed86cf

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,26 @@ You should create a named branch for your changes, before committing, as using P
3636
git checkout -b my-feature-branch
3737
```
3838

39+
## Current project structure
40+
41+
Note - the goal is to arrive at a better structure, that is a work in progress.
42+
43+
- .github/ -> github workflows, linter configurations, utility scripts (including desk ones - not ideal)
44+
- _data -> json file for eleventy data
45+
- _drafts -> WIP posts, old content that should be completed, or pulled and should be on another blog. It has some utility scripts and tools that should not be here.
46+
- _image_sources -> SVG files, high resolution images before processing, XMP or image process data files. Should not be uploaded to the site. Candidate for LFS.
47+
- _includes -> liquid include files carried from jekyll into 11ty. They are still very much in use - templates, layouts, render components and utilities.
48+
- _posts -> json data for the list of blog posts. Might be redundant, the state of that json file needs checking and moving/removal if it's not in use.
49+
- admin -> netlify admin tools, intended for an easy way to add/edit posts without being directly in github. Not currently working, but has worked before.
50+
- assets -> a mixutre of style assets (logos and tools), downloadable file assets, and images for posts or wiki pages. Ideally - it should only be the style assets with the other parts in galleries.
51+
- content -> Currently all blog posts, wiki and pages are here, with some exceptions. Eventaully, all site rendered markdown and images should be in this structure and not the root folder.
52+
- error_pages -> Landing pages for 404's and similar
53+
- galleries -> Where pictures to be served on the site, and files for downloads should be. Should be under the content folder.
54+
- navigation and indexes -> archive, rss feeds, sitemap pages. Should also be under content. Has site build js which should be in the src folder?
55+
- products -> content for the old shop. Still in some wiki page references, and device specifications - which should go to the wiki. Anything relating to price, shipping should be removed. This folder should be removed.
56+
- src -> Eleventy etensions in JS, scss style stuff. All used in site generation
57+
- / - config scripts for eleventy, tools, linters, readmes. Dockerfiles for serving, some utility tools. It has the main content index and favicon, which should not be there.
58+
3959
## Running locally
4060

4161
You may need to determine dependencies - the docker method is preferred. Direct `npm` usage on the host is discouraged to avoid version mismatches.

0 commit comments

Comments
 (0)