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

contrib: Document the source-code directory structure #2800

Merged
merged 4 commits into from
May 6, 2024

Conversation

claremacrae
Copy link
Collaborator

Description

Add a new page to the Contributing site, explaining the src/ directory structure.

Motivation and Context

Get stuff out of my head.

How has this been tested?

Viewed in Obsidian.

Screenshots (if appropriate)

See https://publish.obsidian.md/tasks-contributing/Code/Structure+of+the+code

Types of changes

Changes visible to users:

  • Contributing Guidelines (prefix: contrib - any improvements to documentation content for contributors - see Contributing to Tasks)

Terms

@claremacrae claremacrae added the type: internal Only regards development or contributing label May 3, 2024
@claremacrae claremacrae changed the title Code structure overview contrib: Document the source-code directory structure May 3, 2024
@claremacrae claremacrae requested a review from ilandikov May 3, 2024 14:10
@claremacrae
Copy link
Collaborator Author

Hi @ilandikov, totally optional - but if you had any feedback on this it would be appreciated!

contributing/Code/Structure of the code.md Outdated Show resolved Hide resolved
contributing/Code/Structure of the code.md Outdated Show resolved Hide resolved
contributing/Code/Structure of the code.md Outdated Show resolved Hide resolved
@ilandikov
Copy link
Collaborator

Hi @ilandikov, totally optional - but if you had any feedback on this it would be appreciated!

Done. I must say, I was nitpicking, overall this is great documentation =)

@claremacrae claremacrae self-assigned this May 6, 2024
@claremacrae
Copy link
Collaborator Author

Thanks for really helpful feedback @ilandikov...

I've made a bunch of improvements in 7e3d6ba.

@claremacrae claremacrae merged commit 1eaa234 into main May 6, 2024
2 checks passed
@claremacrae claremacrae deleted the code-structure-overview branch May 6, 2024 21:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: internal Only regards development or contributing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants