diff --git a/flask_boat.py b/flask_boat.py index df77a6f..4bc3f4b 100644 --- a/flask_boat.py +++ b/flask_boat.py @@ -51,7 +51,7 @@ def render_home(): meta, content = get_md_contents("home.md") projects_list = [] for project in list_folders("./projects"): - project_info = get_md_contents("documentation.md", + project_info = get_md_contents(f"{project}.md", f"./{projects}/{project}")[0] project_date = datetime.strptime(project_info['date'], '%d/%m/%Y') project_info['date'] = datetime.strftime(project_date, '%d %b, %y') @@ -116,7 +116,7 @@ def dynamic_page(slug=None): # Single project @app.route("/projects//") def p_info(project=None): - meta, content = get_md_contents("documentation.md", + meta, content = get_md_contents(f"{project}.md", f"./{projects}/{project}") template = 'project.html' if 'template' in meta: diff --git a/new-project.py b/new-project.py index 2ed793c..b20e111 100644 --- a/new-project.py +++ b/new-project.py @@ -50,6 +50,6 @@ post = frontmatter.Post('', **project) os.makedirs(f'projects/{slug}') -with open(f'projects/{slug}/documentation.md', 'w') as f: +with open(f'projects/{slug}/{slug}.md', 'w') as f: documentation = frontmatter.dumps(post) f.write(documentation) diff --git a/projects/annotation-compass/documentation.md b/projects/annotation-compass/annotation-compass.md similarity index 100% rename from projects/annotation-compass/documentation.md rename to projects/annotation-compass/annotation-compass.md diff --git a/projects/api-worldbuilding/documentation.md b/projects/api-worldbuilding/api-worldbuilding.md similarity index 100% rename from projects/api-worldbuilding/documentation.md rename to projects/api-worldbuilding/api-worldbuilding.md diff --git a/projects/birthday-card/documentation.md b/projects/birthday-card/birthday-card.md similarity index 100% rename from projects/birthday-card/documentation.md rename to projects/birthday-card/birthday-card.md diff --git a/projects/cam-transcript/documentation.md b/projects/cam-transcript/cam-transcript.md similarity index 100% rename from projects/cam-transcript/documentation.md rename to projects/cam-transcript/cam-transcript.md diff --git a/projects/chameleon/documentation.md b/projects/chameleon/chameleon.md similarity index 100% rename from projects/chameleon/documentation.md rename to projects/chameleon/chameleon.md diff --git a/projects/chaotic-evil-puzzles/documentation.md b/projects/chaotic-evil-puzzles/chaotic-evil-puzzles.md similarity index 100% rename from projects/chaotic-evil-puzzles/documentation.md rename to projects/chaotic-evil-puzzles/chaotic-evil-puzzles.md diff --git a/projects/chat-reader/documentation.md b/projects/chat-reader/chat-reader.md similarity index 100% rename from projects/chat-reader/documentation.md rename to projects/chat-reader/chat-reader.md diff --git a/projects/cms-00/documentation.md b/projects/cms-00/cms-00.md similarity index 100% rename from projects/cms-00/documentation.md rename to projects/cms-00/cms-00.md diff --git a/projects/concrete-label/documentation.md b/projects/concrete-label/concrete-label.md similarity index 100% rename from projects/concrete-label/documentation.md rename to projects/concrete-label/concrete-label.md diff --git a/projects/documentation-template/documentation.md b/projects/documentation-template/documentation-template.md similarity index 100% rename from projects/documentation-template/documentation.md rename to projects/documentation-template/documentation-template.md diff --git a/projects/frana-futura/documentation.md b/projects/frana-futura/frana-futura.md similarity index 100% rename from projects/frana-futura/documentation.md rename to projects/frana-futura/frana-futura.md diff --git a/projects/gpp/documentation.md b/projects/gpp/gpp.md similarity index 99% rename from projects/gpp/documentation.md rename to projects/gpp/gpp.md index 06809d6..93e50db 100644 --- a/projects/gpp/documentation.md +++ b/projects/gpp/gpp.md @@ -43,6 +43,7 @@ Documentation is a way to produce narrations around software. To create a world - Read software documentation - (manuals, guides, references, tutorial) +- (good ones, bad ones, ...) - Which software needs documentation? or - Which software do we want to document? - Write software documentation diff --git a/projects/graduation-divination/documentation.md b/projects/graduation-divination/graduation-divination.md similarity index 100% rename from projects/graduation-divination/documentation.md rename to projects/graduation-divination/graduation-divination.md diff --git a/projects/grs/documentation.md b/projects/grs/grs.md similarity index 100% rename from projects/grs/documentation.md rename to projects/grs/grs.md diff --git a/projects/k-pub/documentation.md b/projects/k-pub/k-pub.md similarity index 100% rename from projects/k-pub/documentation.md rename to projects/k-pub/k-pub.md diff --git a/projects/katamari-fanfic/documentation.md b/projects/katamari-fanfic/katamari-fanfic.md similarity index 100% rename from projects/katamari-fanfic/documentation.md rename to projects/katamari-fanfic/katamari-fanfic.md diff --git a/projects/kiwibot/documentation.md b/projects/kiwibot/kiwibot.md similarity index 100% rename from projects/kiwibot/documentation.md rename to projects/kiwibot/kiwibot.md diff --git a/projects/lifeboats/documentation.md b/projects/lifeboats/lifeboats.md similarity index 100% rename from projects/lifeboats/documentation.md rename to projects/lifeboats/lifeboats.md diff --git a/projects/lifespan/documentation.md b/projects/lifespan/lifespan.md similarity index 100% rename from projects/lifespan/documentation.md rename to projects/lifespan/lifespan.md diff --git a/projects/loot-box-decorator/documentation.md b/projects/loot-box-decorator/loot-box-decorator.md similarity index 100% rename from projects/loot-box-decorator/documentation.md rename to projects/loot-box-decorator/loot-box-decorator.md diff --git a/projects/loot-box-multi-player/documentation.md b/projects/loot-box-multi-player/loot-box-multi-player.md similarity index 100% rename from projects/loot-box-multi-player/documentation.md rename to projects/loot-box-multi-player/loot-box-multi-player.md diff --git a/projects/loot-box-sealing-device/documentation.md b/projects/loot-box-sealing-device/loot-box-sealing-device.md similarity index 100% rename from projects/loot-box-sealing-device/documentation.md rename to projects/loot-box-sealing-device/loot-box-sealing-device.md diff --git a/projects/loot-box-temporality/documentation.md b/projects/loot-box-temporality/loot-box-temporality.md similarity index 100% rename from projects/loot-box-temporality/documentation.md rename to projects/loot-box-temporality/loot-box-temporality.md diff --git a/projects/mimic/documentation.md b/projects/mimic/mimic.md similarity index 100% rename from projects/mimic/documentation.md rename to projects/mimic/mimic.md diff --git a/projects/notation-system/documentation.md b/projects/notation-system/notation-system.md similarity index 100% rename from projects/notation-system/documentation.md rename to projects/notation-system/notation-system.md diff --git a/projects/ooc-summer-session/documentation.md b/projects/ooc-summer-session/ooc-summer-session.md similarity index 100% rename from projects/ooc-summer-session/documentation.md rename to projects/ooc-summer-session/ooc-summer-session.md diff --git a/projects/padliography-2/documentation.md b/projects/padliography-2/padliography-2.md similarity index 100% rename from projects/padliography-2/documentation.md rename to projects/padliography-2/padliography-2.md diff --git a/projects/padliography/documentation.md b/projects/padliography/padliography.md similarity index 100% rename from projects/padliography/documentation.md rename to projects/padliography/padliography.md diff --git a/projects/panel/documentation.md b/projects/panel/panel.md similarity index 100% rename from projects/panel/documentation.md rename to projects/panel/panel.md diff --git a/projects/pimp/documentation.md b/projects/pimp/pimp.md similarity index 100% rename from projects/pimp/documentation.md rename to projects/pimp/pimp.md diff --git a/projects/plotter-pattern/documentation.md b/projects/plotter-pattern/plotter-pattern.md similarity index 100% rename from projects/plotter-pattern/documentation.md rename to projects/plotter-pattern/plotter-pattern.md diff --git a/projects/post-flask/documentation.md b/projects/post-flask/post-flask.md similarity index 100% rename from projects/post-flask/documentation.md rename to projects/post-flask/post-flask.md diff --git a/projects/postit-contents/documentation.md b/projects/postit-contents/postit-contents.md similarity index 100% rename from projects/postit-contents/documentation.md rename to projects/postit-contents/postit-contents.md diff --git a/projects/postit-gen/documentation.md b/projects/postit-gen/postit-gen.md similarity index 100% rename from projects/postit-gen/documentation.md rename to projects/postit-gen/postit-gen.md diff --git a/projects/postit-identity/documentation.md b/projects/postit-identity/postit-identity.md similarity index 100% rename from projects/postit-identity/documentation.md rename to projects/postit-identity/postit-identity.md diff --git a/projects/rejection/documentation.md b/projects/rejection/rejection.md similarity index 100% rename from projects/rejection/documentation.md rename to projects/rejection/rejection.md diff --git a/projects/si16-API-express-prototype/documentation.md b/projects/si16-API-express-prototype/si16-API-express-prototype.md similarity index 100% rename from projects/si16-API-express-prototype/documentation.md rename to projects/si16-API-express-prototype/si16-API-express-prototype.md diff --git a/projects/si16-API-strapi-nuxt-prototype/documentation.md b/projects/si16-API-strapi-nuxt-prototype/si16-API-strapi-nuxt-prototype.md similarity index 100% rename from projects/si16-API-strapi-nuxt-prototype/documentation.md rename to projects/si16-API-strapi-nuxt-prototype/si16-API-strapi-nuxt-prototype.md diff --git a/projects/si16-backend/documentation.md b/projects/si16-backend/si16-backend.md similarity index 100% rename from projects/si16-backend/documentation.md rename to projects/si16-backend/si16-backend.md diff --git a/projects/si16-frontend-design/documentation.md b/projects/si16-frontend-design/si16-frontend-design.md similarity index 100% rename from projects/si16-frontend-design/documentation.md rename to projects/si16-frontend-design/si16-frontend-design.md diff --git a/projects/si16-structure-proposal/documentation.md b/projects/si16-structure-proposal/si16-structure-proposal.md similarity index 100% rename from projects/si16-structure-proposal/documentation.md rename to projects/si16-structure-proposal/si16-structure-proposal.md diff --git a/projects/si17-homepage/documentation.md b/projects/si17-homepage/si17-homepage.md similarity index 100% rename from projects/si17-homepage/documentation.md rename to projects/si17-homepage/si17-homepage.md diff --git a/projects/si17-public/documentation.md b/projects/si17-public/si17-public.md similarity index 100% rename from projects/si17-public/documentation.md rename to projects/si17-public/si17-public.md diff --git a/projects/si18-01-jingles/documentation.md b/projects/si18-01-jingles/si18-01-jingles.md similarity index 100% rename from projects/si18-01-jingles/documentation.md rename to projects/si18-01-jingles/si18-01-jingles.md diff --git a/projects/si18-02-schooling-shoaling/documentation.md b/projects/si18-02-schooling-shoaling/si18-02-schooling-shoaling.md similarity index 100% rename from projects/si18-02-schooling-shoaling/documentation.md rename to projects/si18-02-schooling-shoaling/si18-02-schooling-shoaling.md diff --git a/projects/si18-03-emergent-opera/documentation.md b/projects/si18-03-emergent-opera/si18-03-emergent-opera.md similarity index 100% rename from projects/si18-03-emergent-opera/documentation.md rename to projects/si18-03-emergent-opera/si18-03-emergent-opera.md diff --git a/projects/si18-03-overture-atlas/documentation.md b/projects/si18-03-overture-atlas/si18-03-overture-atlas.md similarity index 100% rename from projects/si18-03-overture-atlas/documentation.md rename to projects/si18-03-overture-atlas/si18-03-overture-atlas.md diff --git a/projects/si18-05-what-is-right-not-to/documentation.md b/projects/si18-05-what-is-right-not-to/si18-05-what-is-right-not-to.md similarity index 100% rename from projects/si18-05-what-is-right-not-to/documentation.md rename to projects/si18-05-what-is-right-not-to/si18-05-what-is-right-not-to.md diff --git a/projects/skimmer/documentation.md b/projects/skimmer/skimmer.md similarity index 100% rename from projects/skimmer/documentation.md rename to projects/skimmer/skimmer.md diff --git a/projects/soup-flask/documentation.md b/projects/soup-flask/soup-flask.md similarity index 100% rename from projects/soup-flask/documentation.md rename to projects/soup-flask/soup-flask.md diff --git a/projects/soup-gen/documentation.md b/projects/soup-gen/soup-gen.md similarity index 100% rename from projects/soup-gen/documentation.md rename to projects/soup-gen/soup-gen.md diff --git a/projects/soup-to-wiki/documentation.md b/projects/soup-to-wiki/soup-to-wiki.md similarity index 100% rename from projects/soup-to-wiki/documentation.md rename to projects/soup-to-wiki/soup-to-wiki.md diff --git a/projects/soup2/documentation.md b/projects/soup2/soup2.md similarity index 98% rename from projects/soup2/documentation.md rename to projects/soup2/soup2.md index b2ac3cc..df41442 100644 --- a/projects/soup2/documentation.md +++ b/projects/soup2/soup2.md @@ -102,4 +102,4 @@ because there are a lot of contents! so probably should really generate the proj **update** -and that's what i did now. let's see if it works? +and that's what i did now. diff --git a/projects/spaghetti/documentation.md b/projects/spaghetti/spaghetti.md similarity index 100% rename from projects/spaghetti/documentation.md rename to projects/spaghetti/spaghetti.md diff --git a/projects/spawn-sticker/documentation.md b/projects/spawn-sticker/spawn-sticker.md similarity index 100% rename from projects/spawn-sticker/documentation.md rename to projects/spawn-sticker/spawn-sticker.md diff --git a/projects/test-static-files/documentation.md b/projects/test-static-files/test-static-files.md similarity index 100% rename from projects/test-static-files/documentation.md rename to projects/test-static-files/test-static-files.md diff --git a/projects/textoscope/documentation.md b/projects/textoscope/textoscope.md similarity index 100% rename from projects/textoscope/documentation.md rename to projects/textoscope/textoscope.md diff --git a/projects/thesis-draft/documentation.md b/projects/thesis-outline/thesis-outline.md similarity index 98% rename from projects/thesis-draft/documentation.md rename to projects/thesis-outline/thesis-outline.md index 296d9c1..fb3aeab 100644 --- a/projects/thesis-draft/documentation.md +++ b/projects/thesis-outline/thesis-outline.md @@ -5,11 +5,11 @@ categories: - Research date: 03/11/2022 description: Outline for the thesis -slug: thesis-draft -title: Thesis Draft +slug: thesis-outline +title: Thesis Outline --- -Guidelines +## Guidelines ``` What do you WANT to write? diff --git a/projects/weaving/documentation.md b/projects/weaving/weaving.md similarity index 100% rename from projects/weaving/documentation.md rename to projects/weaving/weaving.md diff --git a/projects/word-dimmer/documentation.md b/projects/word-dimmer/word-dimmer.md similarity index 100% rename from projects/word-dimmer/documentation.md rename to projects/word-dimmer/word-dimmer.md diff --git a/projects/workbook/documentation.md b/projects/workbook/workbook.md similarity index 100% rename from projects/workbook/documentation.md rename to projects/workbook/workbook.md diff --git a/projects/workinon/documentation.md b/projects/workinon/workinon.md similarity index 100% rename from projects/workinon/documentation.md rename to projects/workinon/workinon.md diff --git a/projects/xquisite/documentation.md b/projects/xquisite/xquisite.md similarity index 100% rename from projects/xquisite/documentation.md rename to projects/xquisite/xquisite.md diff --git a/rename.py b/rename.py new file mode 100644 index 0000000..bf22045 --- /dev/null +++ b/rename.py @@ -0,0 +1,10 @@ +import os + +names = [] + +for entry in os.scandir('projects'): + if not entry.name.startswith('.') and entry.is_dir(): + names.append(entry.name) + +for name in names: + os.rename(f'projects/{name}/documentation.md', f'projects/{name}/{name}.md') \ No newline at end of file