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

[docs] move Makefile from project root to subdir 'docs' #100

Merged
merged 2 commits into from
Jul 7, 2021

Conversation

umarcor
Copy link
Collaborator

@umarcor umarcor commented Jul 6, 2021

Initially, we put the Makefile for building the docs in the root of the repo, because we expected to add entrypoints for other tasks in the same file. However, given how the rest of the repo evolved, that is probably not going to happen. We will probably have some orchestration/entrypoint in the root which wraps the different makefiles. Therefore, this PR moves the Makefile for building the documentation into subdir docs.

@stnolting
Copy link
Owner

I like that! 👍
Make the root directory a little bit cleaner 😅

@stnolting
Copy link
Owner

I have updated the user guide accordingly.
Everything should be sync now, or did we forget something?

@umarcor
Copy link
Collaborator Author

umarcor commented Jul 7, 2021

I cannot think of any missing piece at the moment. Anyway, we can fix it afterwards in case we forgot anything. Hence, shall we merge?

@stnolting stnolting merged commit 84711a5 into stnolting:master Jul 7, 2021
@umarcor umarcor deleted the doc-makefile branch July 7, 2021 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants