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

Humans_Engine: Update View Quality DocumentationURL #3216

Merged

Conversation

al-fisher
Copy link
Member

Fixing the Documentation URLs to the Humans Engine View Quality Conventions

As part of the Documentation restructuring as per issue BHoM/documentation#85

I matched the new location of the Humans View Quality Conventions page to be both within the BHoM Engine documentation navigation and then with in the same Discipline Engine and Namespace of the methods being documented.

Which seems a logical approach. But as we expand our documentation - will be good to formalise (and document 😄) our documentation conventions further.

@travispotterBH @pawelbaran very relevant to our conversations around documentation long term strategy

@al-fisher
Copy link
Member Author

@BHoMBot check required

Copy link

bhombot-ci bot commented Nov 23, 2023

@al-fisher to confirm, the following actions are now queued:

  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check core
  • check null-handling
  • check serialisation
  • check versioning
  • check installer

Copy link
Contributor

@FraserGreenroyd FraserGreenroyd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Links updated and have checked they work so am happy for this to be deployed for updates to alphas.

@FraserGreenroyd FraserGreenroyd added the type:documentation Wiki, help or in code attributes label Nov 23, 2023
@FraserGreenroyd
Copy link
Contributor

@BHoMBot this is a DevOps instruction. I am requesting neutral checks on: dataset-compliance, unit-tests

Copy link

bhombot-ci bot commented Nov 23, 2023

@FraserGreenroyd I have provided neutral checks to the checks requested. These checks will need to be run properly to obtain full results.

@FraserGreenroyd
Copy link
Contributor

@BHoMBot check copyright-compliance

Copy link

bhombot-ci bot commented Nov 23, 2023

@FraserGreenroyd to confirm, the following actions are now queued:

  • check copyright-compliance

@al-fisher
Copy link
Member Author

Thanks @FraserGreenroyd

@al-fisher
Copy link
Member Author

@BHoMBot check ready-to-merge

Copy link

bhombot-ci bot commented Nov 23, 2023

@al-fisher to confirm, the following actions are now queued:

  • check ready-to-merge

There are 9 requests in the queue ahead of you.

@al-fisher al-fisher merged commit 034bd82 into develop Nov 23, 2023
12 checks passed
@al-fisher al-fisher deleted the Humans_Engine-UpdateLinksToViewQualityDocumentation branch November 23, 2023 14:24
@bhombot-ci bhombot-ci bot mentioned this pull request Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:documentation Wiki, help or in code attributes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants